Skip to main content
POST
cURL
Use Lead setup first to copy a body, fill it, then Try it here.
  • ok: true → safe to POST /api/v1/leads
  • ok: false → read checks (severity: error blocks create)
  • Email needs emailProfileId, emailTemplateId, and templateVariables (object). WhatsApp needs whatsappProfileId, whatsappTemplateId, and whatsappParams (array).

Authorizations

Authorization
string
header
required

Paste only your API key (ond_live_… or ond_test_…). Do not type the word Bearer - the playground adds it.

Body

application/json
campaignId
string
required
Example:

"6a7afae1e1cf2999568febc4"

channel
enum<string>
default:call
required

Dial only. Email and WhatsApp fields are not used.

Available options:
call
phone
string
required
Example:

"+919876543210"

leadId

Your own lead id from your CRM (string or number). Returned unchanged in the response, in error responses and in call webhooks, so you can map every Ondial reply to your lead. Also accepted as metadata.leadId.

Maximum string length: 200
Example:

177

name
string
Example:

"Asha"

priority
enum<string>
default:normal
Available options:
high,
normal
scheduledAt
string<date-time>

When to dial. Defaults to now.

requeue
boolean

Re-arm a finished contact.

metadata
object
Example:

Response

All required checks passed (nothing created)

leadId

Your own lead id, exactly as you sent it. Omitted when you did not send one.

Maximum string length: 200
Example:

177

ok
boolean
campaignId
string
channels
string[]
missing
string[]
warnings
string[]
issues
object[]