Create lead - OnDial API

Create lead

curl --request POST \
  --url https://dashboard.ondial.ai/api/v1/leads \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "campaignId": "6a7afae1e1cf2999568febc4",
  "channel": "call",
  "phone": "+919876543210",
  "name": "Asha",
  "consent": {
    "outboundCall": true,
    "source": "crm"
  },
  "metadata": {
    "leadId": "CRM-99"
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    campaignId: '6a7afae1e1cf2999568febc4',
    channel: 'call',
    phone: '+919876543210',
    name: 'Asha',
    consent: {outboundCall: true, source: 'crm'},
    metadata: {leadId: 'CRM-99'}
  })
};

fetch('https://dashboard.ondial.ai/api/v1/leads', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://dashboard.ondial.ai/api/v1/leads"

payload = {
    "campaignId": "6a7afae1e1cf2999568febc4",
    "channel": "call",
    "phone": "+919876543210",
    "name": "Asha",
    "consent": {
        "outboundCall": True,
        "source": "crm"
    },
    "metadata": { "leadId": "CRM-99" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "contactId": "6a7acd39a82e957a556ff6b3",
  "campaignId": "6a7acc769198505873b9c0b0",
  "channels": [
    "call"
  ],
  "status": "sandbox_accepted",
  "mode": "sandbox"
}

POST

/

api

/

v1

/

leads

Create lead

curl --request POST \
  --url https://dashboard.ondial.ai/api/v1/leads \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "campaignId": "6a7afae1e1cf2999568febc4",
  "channel": "call",
  "phone": "+919876543210",
  "name": "Asha",
  "consent": {
    "outboundCall": true,
    "source": "crm"
  },
  "metadata": {
    "leadId": "CRM-99"
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    campaignId: '6a7afae1e1cf2999568febc4',
    channel: 'call',
    phone: '+919876543210',
    name: 'Asha',
    consent: {outboundCall: true, source: 'crm'},
    metadata: {leadId: 'CRM-99'}
  })
};

fetch('https://dashboard.ondial.ai/api/v1/leads', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://dashboard.ondial.ai/api/v1/leads"

payload = {
    "campaignId": "6a7afae1e1cf2999568febc4",
    "channel": "call",
    "phone": "+919876543210",
    "name": "Asha",
    "consent": {
        "outboundCall": True,
        "source": "crm"
    },
    "metadata": { "leadId": "CRM-99" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "contactId": "6a7acd39a82e957a556ff6b3",
  "campaignId": "6a7acc769198505873b9c0b0",
  "channels": [
    "call"
  ],
  "status": "sandbox_accepted",
  "mode": "sandbox"
}

Pick the Call / Email / WhatsApp tab in Try it. Extra fields for other channels are hidden. First: Lead setup with your campaignId.

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.

Headers

Idempotency-Key

string

Optional. Same key + same body returns the same contact; same key + different body → 409.

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"

Hide child attributes

Must be true to place a dial. Not used for email or WhatsApp.

Example:

"crm"

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:

{ "leadId": "CRM-99" }

Response

Accepted

contactId

string

campaignId

string

channels

string[]

status

string

mode

enum<string>

Available options:

live,

sandbox

reasonCode

string

scheduledAt

string<date-time> | null

emailScheduledAt

string<date-time> | null

whatsappScheduledAt

string<date-time> | null

emailTemplateId

string | null

emailProfileId

string | null

whatsappTemplateId

string | null

whatsappProfileId

string | null

templateVariables

object | null

whatsappParams

string[] | null