Create leads (bulk)

cURL

curl -sS -X POST "https://dashboard.ondial.ai/api/v1/leads/bulk" \
  -H "Authorization: Bearer $ONDIAL_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: crm-12345" \
  -d '{
  "campaignId": "6a7afae1e1cf2999568febc4",
  "defaults": {
    "channel": "call",
    "consent": {
      "outboundCall": true,
      "source": "crm"
    }
  },
  "leads": [
    {
      "clientRef": "CRM-1",
      "phone": "+919876543210",
      "name": "Asha",
      "metadata": {
        "leadId": "CRM-1"
      }
    },
    {
      "clientRef": "CRM-2",
      "phone": "+919812345678",
      "name": "Ravi",
      "priority": "high"
    }
  ]
}'

const res = await fetch("https://dashboard.ondial.ai/api/v1/leads/bulk", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.ONDIAL_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": "crm-12345",
  },
  body: JSON.stringify({
    "campaignId": "6a7afae1e1cf2999568febc4",
    "defaults": {
      "channel": "call",
      "consent": {
        "outboundCall": true,
        "source": "crm"
      }
    },
    "leads": [
      {
        "clientRef": "CRM-1",
        "phone": "+919876543210",
        "name": "Asha",
        "metadata": {
          "leadId": "CRM-1"
        }
      },
      {
        "clientRef": "CRM-2",
        "phone": "+919812345678",
        "name": "Ravi",
        "priority": "high"
      }
    ]
  }),
});
const data = await res.json();
console.log(res.status, data);

import os
import requests

res = requests.request(
    "POST",
    "https://dashboard.ondial.ai/api/v1/leads/bulk",
    headers={
        "Authorization": f"Bearer {os.environ['ONDIAL_API_KEY']}",
        "Idempotency-Key": "crm-12345",
    },
    json={
        "campaignId": "6a7afae1e1cf2999568febc4",
        "defaults": {
            "channel": "call",
            "consent": {
                "outboundCall": True,
                "source": "crm",
            },
        },
        "leads": [
            {
                "clientRef": "CRM-1",
                "phone": "+919876543210",
                "name": "Asha",
                "metadata": {
                    "leadId": "CRM-1",
                },
            },
            {
                "clientRef": "CRM-2",
                "phone": "+919812345678",
                "name": "Ravi",
                "priority": "high",
            },
        ],
    },
    timeout=30,
)
print(res.status_code, res.json())

<?php

$ch = curl_init("https://dashboard.ondial.ai/api/v1/leads/bulk");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("ONDIAL_API_KEY"),
        "Content-Type: application/json",
        "Idempotency-Key: crm-12345",
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'campaignId' => '6a7afae1e1cf2999568febc4',
        'defaults' => [
            'channel' => 'call',
            'consent' => [
                'outboundCall' => true,
                'source' => 'crm',
            ],
        ],
        'leads' => [
            [
                'clientRef' => 'CRM-1',
                'phone' => '+919876543210',
                'name' => 'Asha',
                'metadata' => [
                    'leadId' => 'CRM-1',
                ],
            ],
            [
                'clientRef' => 'CRM-2',
                'phone' => '+919812345678',
                'name' => 'Ravi',
                'priority' => 'high',
            ],
        ],
    ]),
]);

$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status . " " . $response;

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
  public static void main(String[] args) throws Exception {
    HttpClient client = HttpClient.newHttpClient();
    HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://dashboard.ondial.ai/api/v1/leads/bulk"))
    .header("Authorization", "Bearer " + System.getenv("ONDIAL_API_KEY"))
    .header("Content-Type", "application/json")
    .header("Idempotency-Key", "crm-12345")
    .method("POST", HttpRequest.BodyPublishers.ofString("""
{
  "campaignId": "6a7afae1e1cf2999568febc4",
  "defaults": {
    "channel": "call",
    "consent": {
      "outboundCall": true,
      "source": "crm"
    }
  },
  "leads": [
    {
      "clientRef": "CRM-1",
      "phone": "+919876543210",
      "name": "Asha",
      "metadata": {
        "leadId": "CRM-1"
      }
    },
    {
      "clientRef": "CRM-2",
      "phone": "+919812345678",
      "name": "Ravi",
      "priority": "high"
    }
  ]
}
"""))
    .build();

    HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.statusCode() + " " + response.body());
  }
}

using System;
using System.Net.Http;
using System.Text;

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://dashboard.ondial.ai/api/v1/leads/bulk");
request.Headers.Add("Authorization", "Bearer " + Environment.GetEnvironmentVariable("ONDIAL_API_KEY"));
request.Headers.Add("Idempotency-Key", "crm-12345");
request.Content = new StringContent("""
{
  "campaignId": "6a7afae1e1cf2999568febc4",
  "defaults": {
    "channel": "call",
    "consent": {
      "outboundCall": true,
      "source": "crm"
    }
  },
  "leads": [
    {
      "clientRef": "CRM-1",
      "phone": "+919876543210",
      "name": "Asha",
      "metadata": {
        "leadId": "CRM-1"
      }
    },
    {
      "clientRef": "CRM-2",
      "phone": "+919812345678",
      "name": "Ravi",
      "priority": "high"
    }
  ]
}
""", Encoding.UTF8, "application/json");

var response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode + " " + await response.Content.ReadAsStringAsync());

package main

import (
	"bytes"
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	body := []byte(`{
  "campaignId": "6a7afae1e1cf2999568febc4",
  "defaults": {
    "channel": "call",
    "consent": {
      "outboundCall": true,
      "source": "crm"
    }
  },
  "leads": [
    {
      "clientRef": "CRM-1",
      "phone": "+919876543210",
      "name": "Asha",
      "metadata": {
        "leadId": "CRM-1"
      }
    },
    {
      "clientRef": "CRM-2",
      "phone": "+919812345678",
      "name": "Ravi",
      "priority": "high"
    }
  ]
}`)
	req, _ := http.NewRequest("POST", "https://dashboard.ondial.ai/api/v1/leads/bulk", bytes.NewBuffer(body))
	req.Header.Set("Authorization", "Bearer "+os.Getenv("ONDIAL_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("Idempotency-Key", "crm-12345")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	out, _ := io.ReadAll(res.Body)
	fmt.Println(res.StatusCode, string(out))
}

{
  "batchId": "<string>",
  "campaignId": "<string>",
  "mode": "live",
  "dryRun": true,
  "idempotentReplay": true,
  "summary": {
    "received": 123,
    "accepted": 123,
    "rejected": 123,
    "duplicates": 123,
    "queuedPaused": 123
  },
  "results": [
    {
      "leadId": 177,
      "index": 123,
      "clientRef": "<string>",
      "status": "accepted",
      "contactId": "<string>",
      "action": "created",
      "reasonCode": "<string>",
      "error": "<string>",
      "details": {},
      "channels": [
        "<string>"
      ],
      "scheduledAt": "2023-11-07T05:31:56Z"
    }
  ],
  "warnings": [
    "<string>"
  ]
}

POST

https://dashboard.ondial.ai

api

leads

bulk

cURL

curl -sS -X POST "https://dashboard.ondial.ai/api/v1/leads/bulk" \
  -H "Authorization: Bearer $ONDIAL_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: crm-12345" \
  -d '{
  "campaignId": "6a7afae1e1cf2999568febc4",
  "defaults": {
    "channel": "call",
    "consent": {
      "outboundCall": true,
      "source": "crm"
    }
  },
  "leads": [
    {
      "clientRef": "CRM-1",
      "phone": "+919876543210",
      "name": "Asha",
      "metadata": {
        "leadId": "CRM-1"
      }
    },
    {
      "clientRef": "CRM-2",
      "phone": "+919812345678",
      "name": "Ravi",
      "priority": "high"
    }
  ]
}'

const res = await fetch("https://dashboard.ondial.ai/api/v1/leads/bulk", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.ONDIAL_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": "crm-12345",
  },
  body: JSON.stringify({
    "campaignId": "6a7afae1e1cf2999568febc4",
    "defaults": {
      "channel": "call",
      "consent": {
        "outboundCall": true,
        "source": "crm"
      }
    },
    "leads": [
      {
        "clientRef": "CRM-1",
        "phone": "+919876543210",
        "name": "Asha",
        "metadata": {
          "leadId": "CRM-1"
        }
      },
      {
        "clientRef": "CRM-2",
        "phone": "+919812345678",
        "name": "Ravi",
        "priority": "high"
      }
    ]
  }),
});
const data = await res.json();
console.log(res.status, data);

import os
import requests

res = requests.request(
    "POST",
    "https://dashboard.ondial.ai/api/v1/leads/bulk",
    headers={
        "Authorization": f"Bearer {os.environ['ONDIAL_API_KEY']}",
        "Idempotency-Key": "crm-12345",
    },
    json={
        "campaignId": "6a7afae1e1cf2999568febc4",
        "defaults": {
            "channel": "call",
            "consent": {
                "outboundCall": True,
                "source": "crm",
            },
        },
        "leads": [
            {
                "clientRef": "CRM-1",
                "phone": "+919876543210",
                "name": "Asha",
                "metadata": {
                    "leadId": "CRM-1",
                },
            },
            {
                "clientRef": "CRM-2",
                "phone": "+919812345678",
                "name": "Ravi",
                "priority": "high",
            },
        ],
    },
    timeout=30,
)
print(res.status_code, res.json())

<?php

$ch = curl_init("https://dashboard.ondial.ai/api/v1/leads/bulk");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("ONDIAL_API_KEY"),
        "Content-Type: application/json",
        "Idempotency-Key: crm-12345",
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'campaignId' => '6a7afae1e1cf2999568febc4',
        'defaults' => [
            'channel' => 'call',
            'consent' => [
                'outboundCall' => true,
                'source' => 'crm',
            ],
        ],
        'leads' => [
            [
                'clientRef' => 'CRM-1',
                'phone' => '+919876543210',
                'name' => 'Asha',
                'metadata' => [
                    'leadId' => 'CRM-1',
                ],
            ],
            [
                'clientRef' => 'CRM-2',
                'phone' => '+919812345678',
                'name' => 'Ravi',
                'priority' => 'high',
            ],
        ],
    ]),
]);

$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status . " " . $response;

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
  public static void main(String[] args) throws Exception {
    HttpClient client = HttpClient.newHttpClient();
    HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://dashboard.ondial.ai/api/v1/leads/bulk"))
    .header("Authorization", "Bearer " + System.getenv("ONDIAL_API_KEY"))
    .header("Content-Type", "application/json")
    .header("Idempotency-Key", "crm-12345")
    .method("POST", HttpRequest.BodyPublishers.ofString("""
{
  "campaignId": "6a7afae1e1cf2999568febc4",
  "defaults": {
    "channel": "call",
    "consent": {
      "outboundCall": true,
      "source": "crm"
    }
  },
  "leads": [
    {
      "clientRef": "CRM-1",
      "phone": "+919876543210",
      "name": "Asha",
      "metadata": {
        "leadId": "CRM-1"
      }
    },
    {
      "clientRef": "CRM-2",
      "phone": "+919812345678",
      "name": "Ravi",
      "priority": "high"
    }
  ]
}
"""))
    .build();

    HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.statusCode() + " " + response.body());
  }
}

using System;
using System.Net.Http;
using System.Text;

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://dashboard.ondial.ai/api/v1/leads/bulk");
request.Headers.Add("Authorization", "Bearer " + Environment.GetEnvironmentVariable("ONDIAL_API_KEY"));
request.Headers.Add("Idempotency-Key", "crm-12345");
request.Content = new StringContent("""
{
  "campaignId": "6a7afae1e1cf2999568febc4",
  "defaults": {
    "channel": "call",
    "consent": {
      "outboundCall": true,
      "source": "crm"
    }
  },
  "leads": [
    {
      "clientRef": "CRM-1",
      "phone": "+919876543210",
      "name": "Asha",
      "metadata": {
        "leadId": "CRM-1"
      }
    },
    {
      "clientRef": "CRM-2",
      "phone": "+919812345678",
      "name": "Ravi",
      "priority": "high"
    }
  ]
}
""", Encoding.UTF8, "application/json");

var response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode + " " + await response.Content.ReadAsStringAsync());

package main

import (
	"bytes"
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	body := []byte(`{
  "campaignId": "6a7afae1e1cf2999568febc4",
  "defaults": {
    "channel": "call",
    "consent": {
      "outboundCall": true,
      "source": "crm"
    }
  },
  "leads": [
    {
      "clientRef": "CRM-1",
      "phone": "+919876543210",
      "name": "Asha",
      "metadata": {
        "leadId": "CRM-1"
      }
    },
    {
      "clientRef": "CRM-2",
      "phone": "+919812345678",
      "name": "Ravi",
      "priority": "high"
    }
  ]
}`)
	req, _ := http.NewRequest("POST", "https://dashboard.ondial.ai/api/v1/leads/bulk", bytes.NewBuffer(body))
	req.Header.Set("Authorization", "Bearer "+os.Getenv("ONDIAL_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("Idempotency-Key", "crm-12345")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	out, _ := io.ReadAll(res.Body)
	fmt.Println(res.StatusCode, string(out))
}

{
  "batchId": "<string>",
  "campaignId": "<string>",
  "mode": "live",
  "dryRun": true,
  "idempotentReplay": true,
  "summary": {
    "received": 123,
    "accepted": 123,
    "rejected": 123,
    "duplicates": 123,
    "queuedPaused": 123
  },
  "results": [
    {
      "leadId": 177,
      "index": 123,
      "clientRef": "<string>",
      "status": "accepted",
      "contactId": "<string>",
      "action": "created",
      "reasonCode": "<string>",
      "error": "<string>",
      "details": {},
      "channels": [
        "<string>"
      ],
      "scheduledAt": "2023-11-07T05:31:56Z"
    }
  ],
  "warnings": [
    "<string>"
  ]
}

First: Lead setup with your campaignId. Full guide with every result code: Bulk 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.

Headers

Idempotency-Key

string

Optional. Same key + same body returns the same response (idempotentReplay: true); same key + different body → 409.

Body

application/json

Call
Email
WhatsApp

campaignId

string

required

All leads in one request go to this campaign.

Example:

"6a7afae1e1cf2999568febc4"

leads

object[]

required

Up to 100 leads per request by default; the limit can be raised for your API key (maximum 500). Over the limit returns 413 bulk_limit_exceeded.

Minimum array length: 1

Hide child attributes

leads.phone

string

required

Example:

"+919876543210"

leads.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

leads.channel

enum<string>

default:call

Dial only. Can be set once in defaults.

Available options:

call

leads.clientRef

string

Your own id for this lead. Returned in the result.

Maximum string length: 100

Example:

"CRM-1"

leads.name

string

Example:

"Asha"

Hide child attributes

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

Example:

"crm"

leads.priority

enum<string>

Available options:

high,

normal

leads.scheduledAt

string<date-time>

When to dial. Defaults to now.

leads.requeue

boolean

Re-arm a finished contact.

leads.metadata

object

Example:

{ "leadId": "CRM-1" }

defaults

object

Used when a lead leaves a field out. Typical: { "channel": "call", "consent": { "outboundCall": true, "source": "crm" } }. A value on the lead wins. metadata is merged.

dryRun

boolean

default:false

Validate every lead and create nothing.

atomic

boolean

default:false

Create nothing unless every lead is valid (422 bulk_atomic_rejected).

Response

Dry run (dryRun: true): validation result per lead, nothing created. Always 200, even when every lead is invalid - read results[].status.

batchId

string

campaignId

string

mode

enum<string>

Available options:

live,

sandbox

dryRun

boolean

idempotentReplay

boolean

summary

object

Hide child attributes

summary.received

integer

summary.accepted

integer

summary.rejected

integer

summary.duplicates

integer

Leads that were duplicates (in the request or already in the campaign).

summary.queuedPaused

integer

Accepted while the campaign is paused; they dial after resume.

results

object[]

Hide child attributes

results.leadId

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

Maximum string length: 200

Example:

177

results.index

integer

Position of the lead in your leads array (starts at 0).

results.clientRef

string

results.status

enum<string>

Available options:

accepted,

queued_paused,

sandbox_accepted,

registered,

rejected,

valid,

not_processed

results.contactId

string

results.action

enum<string>

Available options:

created,

updated,

requeued

results.reasonCode

string | null

Why a lead was rejected, or duplicate_no_requeue when it already existed and was not redialed.

results.error

string

Human-readable reason for a rejection.

results.details

object

results.channels

string[]

results.scheduledAt

string<date-time> | null

warnings

string[]

Basics

Set up and test

Send leads

Track contacts

Calls and recordings

Webhooks

Events

Credits and analytics

Inbound agents

Numbers and voices

Companies

Knowledge bases

Authorizations

Headers

Body

Response