Quick start - OnDial API

1. Get a key

Open API Access, give the key a name, choose sandbox or live, add a why note, and submit. Super Admin approves and shows the plaintext key once. See Request API access.

2. Create an API campaign (dashboard)

Wizard → data source API / Custom CRM → configure script & phone → Start. Copy campaignId. See Create API campaign.

3. Ping / find your campaign

curl -sS -H "Authorization: Bearer $ONDIAL_API_KEY" \
  "$ONDIAL_BASE_URL/api/v1/ping"

Or use Try It on Ping. List API campaigns and copy campaignId: List campaigns. Get campaign shows which email/WhatsApp profile + template that campaign uses.

4. Push a lead

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-lead-1" \
  -d '{
    "campaignId": "YOUR_CAMPAIGN_ID",
    "phone": "+919876543210",
    "name": "Asha",
    "channel": "call",
    "consent": {
      "outboundCall": true,
      "capturedAt": "2026-08-11T10:00:00Z",
      "source": "crm"
    }
  }'

Sandbox keys return sandbox_accepted without live dials.

5. WhatsApp / email without a call

List Omni templates — copy lead, fill blanks
POST /leads with "channel": "whatsapp" or "email", or "channels": ["whatsapp","email"] (no call)
Fill templateVariables (email {{key}}) and whatsappParams ({{1}}, {{2}})

Step-by-step: Send WhatsApp and email.