Push leads from your CRM

Before you POST: Lead setup with your campaignId - copy call.lead / email.lead / whatsapp.lead. Optional Validate lead (nothing is created).

Direct lead push

curl -sS -X POST "$ONDIAL_BASE_URL/api/v1/leads" \
  -H "Authorization: Bearer $ONDIAL_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: crm-$(date +%s)" \
  -d '{
    "campaignId": "YOUR_CAMPAIGN_ID",
    "phone": "+919876543210",
    "leadId": "CRM-99",
    "name": "Asha",
    "scheduledAt": "2026-09-24T04:30:00.000Z",
    "channel": "call",
    "consent": {
      "outboundCall": true,
      "capturedAt": "2026-08-11T10:00:00Z",
      "source": "crm"
    },
    "metadata": {
      "email": "asha@example.com",
      "city": "Ahmedabad",
      "product": "Home loan",
      "source": "website_form",
      "assignedAgent": "agent_12",
      "tags": ["hot", "priority"]
    }
  }'

Omit scheduledAt to dial immediately. ISO 8601 UTC. Scheduler picks up the contact once the clock reaches scheduledAt. metadata is free-form - pass any CRM fields you need back on webhooks / contact records (city, product, owner, tags, etc.).

Your own lead id (`leadId`)

Send your CRM’s id with every lead as leadId (a string up to 200 characters, or a number). Ondial returns it unchanged in the response, in error responses and in call webhooks, so you can match every reply to the right lead in your CRM without storing contactId.

{ "leadId": 177, "phone": "+919723362684", "name": "Palak" }

Accepted - leadId is returned next to contactId:

{
  "leadId": 177,
  "contactId": "6a7acd39…",
  "campaignId": "6a9e…",
  "status": "accepted",
  "channels": ["call"]
}

Rejected - leadId is returned in the error too, so a failed lead is easy to find:

{
  "leadId": 177,
  "error": "Invalid phone number",
  "reasonCode": "invalid_phone"
}

Works on POST /api/v1/leads, POST /api/v1/leads/validate, POST /api/v1/events and each lead of bulk (as results[].leadId).
metadata.leadId still works; the top-level leadId wins when both are sent.
If you don’t send one, leadId is simply left out. A leadId that is not a string or number is rejected with 422 invalid_lead_id.
leadId does not affect duplicate detection: that still uses the phone number or email.
Webhooks that carry it: outbound.lead.created, outbound.lead.updated, call.outbound.status, call.outbound.billed and call.outbound.analysis. See Webhook events.

Many leads at once

Have a list? Use POST /api/v1/leads/bulk: up to 100 leads per request (more on request), one result per lead, dry run and idempotency included.

ERP-style events

Map eventType → campaign via Settings or POST /api/v1/event-routes
POST /api/v1/events with eventType + phone (+ consent)

Full walkthrough (list templates → fill params → send): Send WhatsApp and email.

Direct WhatsApp or email (no dial)

Templates are resolved from the ids you pass (required). Copy them from Lead setup / Omni templates - wrong ids return 422. Send one channel per request. Email:

curl -sS -X POST "$ONDIAL_BASE_URL/api/v1/leads" \
  -H "Authorization: Bearer $ONDIAL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "campaignId": "YOUR_CAMPAIGN_ID",
    "email": "asha@example.com",
    "name": "Asha",
    "channel": "email",
    "emailProfileId": "YOUR_EMAIL_PROFILE_ID",
    "emailTemplateId": "YOUR_EMAIL_TEMPLATE_ID",
    "templateVariables": { "contact_name": "Asha" },
    "emailScheduledAt": "2026-08-13T06:30:00Z"
  }'

templateVariables keys come from your template’s {{placeholders}} (Lead setup). Example keys above are only if that template uses them - otherwise send {} or only the keys you need. WhatsApp:

curl -sS -X POST "$ONDIAL_BASE_URL/api/v1/leads" \
  -H "Authorization: Bearer $ONDIAL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "campaignId": "YOUR_CAMPAIGN_ID",
    "phone": "+919876543210",
    "name": "Asha",
    "channel": "whatsapp",
    "whatsappProfileId": "YOUR_WHATSAPP_PROFILE_ID",
    "whatsappTemplateId": "YOUR_WHATSAPP_TEMPLATE_ID",
    "whatsappParams": [
      "Asha",
      "CRM-99",
      "Home loan",
      "₹5000",
      "30 Sep 2026",
      "https://track.example/abc"
    ],
    "whatsappScheduledAt": "2026-08-13T06:00:00Z"
  }'

whatsappParams[0] → {{1}}, [1] → {{2}}, … (same order as Lead setup paramLabels).

Clock	Template sent
`whatsappScheduledAt`	Template from `whatsappTemplateId`
`emailScheduledAt`	Template from `emailTemplateId`

Non-API campaigns, draft/testing, or closed campaigns return 422 at lead add (not_api_campaign / campaign_not_accepting / campaign_closed). Omit the clocks to send as soon as Calling_system1 picks up the queue. Poll GET /api/v1/contacts/{id} for whatsappQueueStatus / emailStatus.

Requeue a finished contact

If the contact already completed (or otherwise finished), pass "requeue": true on POST /leads / /events to arm another dial.

curl -sS -X POST "$ONDIAL_BASE_URL/api/v1/leads" \
  -H "Authorization: Bearer $ONDIAL_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: crm-requeue-$(date +%s)" \
  -d '{
    "campaignId": "YOUR_CAMPAIGN_ID",
    "phone": "+919876543210",
    "requeue": true,
    "channel": "call",
    "consent": {
      "outboundCall": true,
      "capturedAt": "2026-08-11T10:00:00Z",
      "source": "crm"
    }
  }'

Without requeue: true you get 422 / requeue_required. On success Ondial emits outbound.lead.updated with action: "requeued", then a new dial with a new callId and a fresh call webhook set. Details: CRM & webhooks.

Status + conversation back to CRM

Save contactId from POST /leads (and listen for outbound.lead.created / outbound.lead.updated)
Poll GET /api/v1/contacts/{id} (see lastCall) or listen for call webhooks: call.outbound.status, call.outbound.billed, credits.usage, call.outbound.analysis
Optionally also poll GET /api/v1/calls for a unified inbound+outbound feed
GET /api/v1/contacts/{id}/calls - dial list (hasAnalysis, optional summary)
GET /api/v1/contacts/{id}/calls/{callId} - transcript/turns + normalized analysis (no internal blobs)

Analysis can lag call completion - poll until hasAnalysis: true, or wait for call.outbound.analysis. Optional: register HTTPS webhooks in API Access → Notifications (X-Ondial-Signature). See CRM & webhooks.

Get started

Send leads (outbound)

Answer calls (inbound)

Integrations

Concepts

Go live

Push leads from your CRM

Direct lead push

Your own lead id (`leadId`)

Many leads at once

ERP-style events

Direct WhatsApp or email (no dial)

Requeue a finished contact

Status + conversation back to CRM

​Direct lead push

​Your own lead id (leadId)

​Many leads at once

​ERP-style events

​Direct WhatsApp or email (no dial)

​Requeue a finished contact

​Status + conversation back to CRM

Direct lead push

Your own lead id (`leadId`)

Many leads at once

ERP-style events

Direct WhatsApp or email (no dial)

Requeue a finished contact

Status + conversation back to CRM