Add a Lead

POST

campaigns-leads

Create a new lead for a specific campaign

curl --request POST \
  --url https://api.dialnexa.com/campaigns-leads \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "John Doe",
  "phoneNumber": 9876543210,
  "organisationId": "org_abc123xyz789",
  "campaignId": 5,
  "countryCode": "+91",
  "notes": {
    "customer_id": "123",
    "follow_up": true,
    "tags": [
      "vip",
      "renewal"
    ]
  }
}
'

import requests

url = "https://api.dialnexa.com/campaigns-leads"

payload = {
    "name": "John Doe",
    "phoneNumber": 9876543210,
    "organisationId": "org_abc123xyz789",
    "campaignId": 5,
    "countryCode": "+91",
    "notes": {
        "customer_id": "123",
        "follow_up": True,
        "tags": ["vip", "renewal"]
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'John Doe',
    phoneNumber: 9876543210,
    organisationId: 'org_abc123xyz789',
    campaignId: 5,
    countryCode: '+91',
    notes: {customer_id: '123', follow_up: true, tags: ['vip', 'renewal']}
  })
};

fetch('https://api.dialnexa.com/campaigns-leads', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dialnexa.com/campaigns-leads",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'John Doe',
    'phoneNumber' => 9876543210,
    'organisationId' => 'org_abc123xyz789',
    'campaignId' => 5,
    'countryCode' => '+91',
    'notes' => [
        'customer_id' => '123',
        'follow_up' => true,
        'tags' => [
                'vip',
                'renewal'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dialnexa.com/campaigns-leads"

	payload := strings.NewReader("{\n  \"name\": \"John Doe\",\n  \"phoneNumber\": 9876543210,\n  \"organisationId\": \"org_abc123xyz789\",\n  \"campaignId\": 5,\n  \"countryCode\": \"+91\",\n  \"notes\": {\n    \"customer_id\": \"123\",\n    \"follow_up\": true,\n    \"tags\": [\n      \"vip\",\n      \"renewal\"\n    ]\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.dialnexa.com/campaigns-leads")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"John Doe\",\n  \"phoneNumber\": 9876543210,\n  \"organisationId\": \"org_abc123xyz789\",\n  \"campaignId\": 5,\n  \"countryCode\": \"+91\",\n  \"notes\": {\n    \"customer_id\": \"123\",\n    \"follow_up\": true,\n    \"tags\": [\n      \"vip\",\n      \"renewal\"\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dialnexa.com/campaigns-leads")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"John Doe\",\n  \"phoneNumber\": 9876543210,\n  \"organisationId\": \"org_abc123xyz789\",\n  \"campaignId\": 5,\n  \"countryCode\": \"+91\",\n  \"notes\": {\n    \"customer_id\": \"123\",\n    \"follow_up\": true,\n    \"tags\": [\n      \"vip\",\n      \"renewal\"\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "lead_abc123"
}

Legacy endpoint - deprecated. Unversioned endpoints are scheduled for removal on July 31, 2026. A public v1 replacement is not currently listed in the v1 reference. This endpoint remains available for existing integrations until then.

Adds one lead to a campaign. The lead will be queued for calling according to the campaign’s schedule and concurrency settings.

Dynamic variables via `notes`

Pass custom data in the notes object (up to 15 key-value pairs). These become dynamic variables available in the agent’s prompt via {{variable_name}}:

{
  "name": "Priya Sharma",
  "phoneNumber": "9876543210",
  "countryCode": "+91",
  "campaignId": "cmp_xyz789",
  "notes": {
    "loan_amount": "500000",
    "product": "home_loan",
    "last_contacted": "2024-01-10",
    "agent_name": "Rahul"
  }
}

In your agent prompt, reference these as {{loan_amount}}, {{product}}, etc. The agent receives a personalized briefing before every call.

Bulk upload

If you need to add hundreds or thousands of leads at once, use Bulk Upload with a CSV or XLSX file instead.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

campaignId

string

required

ID of the campaign

Body

application/json

name

string

required

Name of the lead

Example:

"John Doe"

phoneNumber

string

required

Phone number without country code

Example:

9876543210

organisationId

string

required

Organisation ID to which the lead belongs (string of length 14)

Example:

"org_abc123xyz789"

campaignId

string

required

Campaign ID to which the lead is associated

Example:

5

countryCode

string

Country code of the lead. Default is "+91".

Example:

"+91"

notes

object

Optional notes JSON for the lead. Maximum 15 top-level keys.

Example:

{
  "customer_id": "123",
  "follow_up": true,
  "tags": ["vip", "renewal"]
}

Response

Lead created successfully

string

required

Signed lead ID

Example:

"lead_abc123"

Get Campaign LeadFetch a single campaign lead record, including contact data, call status, and a reference to its produced call log.

Create a new lead for a specific campaign

curl --request POST \
  --url https://api.dialnexa.com/campaigns-leads \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "John Doe",
  "phoneNumber": 9876543210,
  "organisationId": "org_abc123xyz789",
  "campaignId": 5,
  "countryCode": "+91",
  "notes": {
    "customer_id": "123",
    "follow_up": true,
    "tags": [
      "vip",
      "renewal"
    ]
  }
}
'

import requests

url = "https://api.dialnexa.com/campaigns-leads"

payload = {
    "name": "John Doe",
    "phoneNumber": 9876543210,
    "organisationId": "org_abc123xyz789",
    "campaignId": 5,
    "countryCode": "+91",
    "notes": {
        "customer_id": "123",
        "follow_up": True,
        "tags": ["vip", "renewal"]
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'John Doe',
    phoneNumber: 9876543210,
    organisationId: 'org_abc123xyz789',
    campaignId: 5,
    countryCode: '+91',
    notes: {customer_id: '123', follow_up: true, tags: ['vip', 'renewal']}
  })
};

fetch('https://api.dialnexa.com/campaigns-leads', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dialnexa.com/campaigns-leads",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'John Doe',
    'phoneNumber' => 9876543210,
    'organisationId' => 'org_abc123xyz789',
    'campaignId' => 5,
    'countryCode' => '+91',
    'notes' => [
        'customer_id' => '123',
        'follow_up' => true,
        'tags' => [
                'vip',
                'renewal'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dialnexa.com/campaigns-leads"

	payload := strings.NewReader("{\n  \"name\": \"John Doe\",\n  \"phoneNumber\": 9876543210,\n  \"organisationId\": \"org_abc123xyz789\",\n  \"campaignId\": 5,\n  \"countryCode\": \"+91\",\n  \"notes\": {\n    \"customer_id\": \"123\",\n    \"follow_up\": true,\n    \"tags\": [\n      \"vip\",\n      \"renewal\"\n    ]\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.dialnexa.com/campaigns-leads")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"John Doe\",\n  \"phoneNumber\": 9876543210,\n  \"organisationId\": \"org_abc123xyz789\",\n  \"campaignId\": 5,\n  \"countryCode\": \"+91\",\n  \"notes\": {\n    \"customer_id\": \"123\",\n    \"follow_up\": true,\n    \"tags\": [\n      \"vip\",\n      \"renewal\"\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dialnexa.com/campaigns-leads")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"John Doe\",\n  \"phoneNumber\": 9876543210,\n  \"organisationId\": \"org_abc123xyz789\",\n  \"campaignId\": 5,\n  \"countryCode\": \"+91\",\n  \"notes\": {\n    \"customer_id\": \"123\",\n    \"follow_up\": true,\n    \"tags\": [\n      \"vip\",\n      \"renewal\"\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "lead_abc123"
}

Overview

Endpoints - v1

Endpoints - Legacy

Code Examples And SDK Status

Dynamic variables via `notes`

Bulk upload

Authorizations

Path Parameters

Body

Response

​Dynamic variables via notes

​Bulk upload

Authorizations

Path Parameters

Body

Response

Dynamic variables via `notes`

Bulk upload