Quickstart

This guide walks you through creating your first client, offer, playbook, and submitting a contact via the API.

Prerequisites

• A VayaFlow account with an active organization
• An API key (see API Keys)

Step 1: Create a Client

Clients represent the businesses that receive your contacts. Navigate to Clients in the sidebar and click Add Client.

Provide a name and any relevant contact details. The client will be available to associate with offers and playbooks.

Step 2: Create an Offer

Offers represent what a client is buying contacts for. Go to Offers and click Add Offer.

Link the offer to your client and configure the offer category and details.

Step 3: Create a Playbook

Playbooks are the central configuration unit. Navigate to Playbooks and click Create Playbook.

1. Give your playbook a name and select the client and offer
2. Set up a delivery endpoint — where qualified contacts will be sent
3. Configure basic routing rules — conditions that determine which contacts match this playbook
4. Optionally set delivery limits and schedules

Step 4: Submit a Contact

Use the API to submit a contact:

curl -X POST https://api.vayaflow.com/api/v1/contacts/submit \
  -H "X-API-Key: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "playbookId": "cmp_your-playbook-id",
    "firstName": "John",
    "lastName": "Doe",
    "email": "john@example.com",
    "phone": "+15551234567"
  }'

The contact will be routed, qualified, and delivered based on your playbook configuration.

Next Steps

• Authentication — Learn about JWT and API key auth
• Playbooks Overview — Deep dive into playbook configuration
• Contact Lifecycle — Understand contact statuses and flow