Lead setup

Lead setup for a campaign

curl --request GET \
  --url https://dashboard.ondial.ai/api/v1/campaigns/{campaignId}/lead-setup \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://dashboard.ondial.ai/api/v1/campaigns/{campaignId}/lead-setup', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://dashboard.ondial.ai/api/v1/campaigns/{campaignId}/lead-setup"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "ok": true,
  "campaignId": "6a7afae1e1cf2999568febc4",
  "name": "TEst API",
  "status": "active",
  "readyFor": {
    "call": true,
    "email": true,
    "whatsapp": true
  },
  "call": {
    "ok": true,
    "lead": {
      "campaignId": "6a7afae1e1cf2999568febc4",
      "channel": "call",
      "phone": "",
      "name": "",
      "consent": {
        "outboundCall": true
      }
    }
  },
  "email": {
    "ok": true,
    "lead": {
      "campaignId": "6a7afae1e1cf2999568febc4",
      "channel": "email",
      "email": "",
      "name": "",
      "emailProfileId": "YOUR_EMAIL_PROFILE_ID",
      "emailTemplateId": "YOUR_EMAIL_TEMPLATE_ID"
    }
  },
  "whatsapp": {
    "ok": true,
    "paramLabels": [
      "Name",
      "Order ID",
      "Product",
      "Amount",
      "Expected Delivery",
      "Tracking URL"
    ],
    "lead": {
      "campaignId": "6a7afae1e1cf2999568febc4",
      "channel": "whatsapp",
      "phone": "",
      "name": "",
      "whatsappProfileId": "YOUR_WHATSAPP_PROFILE_ID",
      "whatsappTemplateId": "YOUR_WHATSAPP_TEMPLATE_ID",
      "whatsappParams": [
        "",
        "",
        "",
        "",
        "",
        ""
      ]
    }
  }
}

GET

api

campaigns

{campaignId}

lead-setup

Lead setup for a campaign

curl --request GET \
  --url https://dashboard.ondial.ai/api/v1/campaigns/{campaignId}/lead-setup \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://dashboard.ondial.ai/api/v1/campaigns/{campaignId}/lead-setup', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://dashboard.ondial.ai/api/v1/campaigns/{campaignId}/lead-setup"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "ok": true,
  "campaignId": "6a7afae1e1cf2999568febc4",
  "name": "TEst API",
  "status": "active",
  "readyFor": {
    "call": true,
    "email": true,
    "whatsapp": true
  },
  "call": {
    "ok": true,
    "lead": {
      "campaignId": "6a7afae1e1cf2999568febc4",
      "channel": "call",
      "phone": "",
      "name": "",
      "consent": {
        "outboundCall": true
      }
    }
  },
  "email": {
    "ok": true,
    "lead": {
      "campaignId": "6a7afae1e1cf2999568febc4",
      "channel": "email",
      "email": "",
      "name": "",
      "emailProfileId": "YOUR_EMAIL_PROFILE_ID",
      "emailTemplateId": "YOUR_EMAIL_TEMPLATE_ID"
    }
  },
  "whatsapp": {
    "ok": true,
    "paramLabels": [
      "Name",
      "Order ID",
      "Product",
      "Amount",
      "Expected Delivery",
      "Tracking URL"
    ],
    "lead": {
      "campaignId": "6a7afae1e1cf2999568febc4",
      "channel": "whatsapp",
      "phone": "",
      "name": "",
      "whatsappProfileId": "YOUR_WHATSAPP_PROFILE_ID",
      "whatsappTemplateId": "YOUR_WHATSAPP_TEMPLATE_ID",
      "whatsappParams": [
        "",
        "",
        "",
        "",
        "",
        ""
      ]
    }
  }
}

Try it with campaignId
readyFor.email / whatsapp / call tells you what you can send
Copy email.lead or whatsapp.lead or call.lead
Fill blanks → POST /api/v1/leads

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.

Path Parameters

campaignId

string

required

Response

Setup checklist + copy-paste lead bodies

boolean

campaignId

string

name

string | null

status

string | null

paused

boolean

readyFor

object

Hide child attributes

readyFor.call

boolean

readyFor.email

boolean

readyFor.whatsapp

boolean

call

object

errors

string[]

Basics

Core

Outbound

Contacts

Events

Inbound agents

Companies

Knowledge bases

Authorizations

Path Parameters

Response