Update Campaign

PATCH

campaigns

{id}

Update a campaign by ID

curl --request PATCH \
  --url https://api.dialnexa.com/campaigns/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-organization-id: <x-organization-id>' \
  --data '
{
  "sent_lead_count": "10",
  "picked_up_lead_count": "10",
  "success_lead_count": "10",
  "completed_leads": "10",
  "failed_leads": "10",
  "number_of_retries": 3,
  "interval_between_retries": 15
}
'

import requests

url = "https://api.dialnexa.com/campaigns/{id}"

payload = {
    "sent_lead_count": "10",
    "picked_up_lead_count": "10",
    "success_lead_count": "10",
    "completed_leads": "10",
    "failed_leads": "10",
    "number_of_retries": 3,
    "interval_between_retries": 15
}
headers = {
    "x-organization-id": "<x-organization-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'x-organization-id': '<x-organization-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    sent_lead_count: '10',
    picked_up_lead_count: '10',
    success_lead_count: '10',
    completed_leads: '10',
    failed_leads: '10',
    number_of_retries: 3,
    interval_between_retries: 15
  })
};

fetch('https://api.dialnexa.com/campaigns/{id}', 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/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'sent_lead_count' => '10',
    'picked_up_lead_count' => '10',
    'success_lead_count' => '10',
    'completed_leads' => '10',
    'failed_leads' => '10',
    'number_of_retries' => 3,
    'interval_between_retries' => 15
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-organization-id: <x-organization-id>"
  ],
]);

$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/{id}"

	payload := strings.NewReader("{\n  \"sent_lead_count\": \"10\",\n  \"picked_up_lead_count\": \"10\",\n  \"success_lead_count\": \"10\",\n  \"completed_leads\": \"10\",\n  \"failed_leads\": \"10\",\n  \"number_of_retries\": 3,\n  \"interval_between_retries\": 15\n}")

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

	req.Header.Add("x-organization-id", "<x-organization-id>")
	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.patch("https://api.dialnexa.com/campaigns/{id}")
  .header("x-organization-id", "<x-organization-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"sent_lead_count\": \"10\",\n  \"picked_up_lead_count\": \"10\",\n  \"success_lead_count\": \"10\",\n  \"completed_leads\": \"10\",\n  \"failed_leads\": \"10\",\n  \"number_of_retries\": 3,\n  \"interval_between_retries\": 15\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dialnexa.com/campaigns/{id}")

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

request = Net::HTTP::Patch.new(url)
request["x-organization-id"] = '<x-organization-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"sent_lead_count\": \"10\",\n  \"picked_up_lead_count\": \"10\",\n  \"success_lead_count\": \"10\",\n  \"completed_leads\": \"10\",\n  \"failed_leads\": \"10\",\n  \"number_of_retries\": 3,\n  \"interval_between_retries\": 15\n}"

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

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.

Updates editable settings on a campaign - primarily the retry policy (number_of_retries, interval_between_retries). Only the fields you include in the request are updated; omitted fields are left unchanged. Refer to the request schema below for the exact set of editable fields.

When to use this

Retry tuning: adjust number_of_retries and interval_between_retries to control how persistently the campaign re-attempts leads that don’t connect.
Renaming: keep the campaign’s display name aligned with the business process it serves.
Retry policy changes: adjust how aggressively DialNexa retries no-answer or busy outcomes. See Auto-retry.
Pausing: set status-related fields to pause delivery while leaving the campaign’s configuration in place.

If you need to swap the agent after calls have started, the cleanest path is to cancel the existing campaign through the dashboard and create a new one with the new agent, that keeps each campaign’s call logs traceable to exactly one agent configuration.

Path parameters

Parameter	Description
`id`	The campaign ID, for example `cmp_5tw8vz2rnx1q`.

Errors

404 Not Found is returned when the campaign does not exist.
400 Bad Request is returned when a field fails validation.
409 Conflict is returned when you try to change agent_id after calls have been placed.

Get Campaign: confirm new settings.
Rate limits: workspace-level caps that apply to campaign dialling.
Auto-retry: how retry policy interacts with call outcomes.

Authorizations

Authorization

string

header

required

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

Headers

x-organization-id

string

required

RSA encrypted organization ID (base64 format)

Example:

"BASE64_ENCRYPTED_ORG_ID_HERE"

Path Parameters

string

required

Body

application/json

sent_lead_count

number

Total Number Failed Leads for this Campaign

Example:

"10"

picked_up_lead_count

number

Total Number Leads who picked up for this Campaign

Example:

"10"

success_lead_count

number

Total Number Successful Leads for this Campaign

Example:

"10"

completed_leads

number

Total Number of Completed Leads for this Campaign

Example:

"10"

failed_leads

number

Total Number of Failed Leads for this Campaign

Example:

"10"

number_of_retries

number

Number of retries for the campaign (0-5)

Example:

3

interval_between_retries

number

Interval between retries in minutes (0-1440)

Example:

15

Response

Campaign updated successfully

Add a LeadAdd a single lead to an existing campaign.

Update a campaign by ID

curl --request PATCH \
  --url https://api.dialnexa.com/campaigns/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-organization-id: <x-organization-id>' \
  --data '
{
  "sent_lead_count": "10",
  "picked_up_lead_count": "10",
  "success_lead_count": "10",
  "completed_leads": "10",
  "failed_leads": "10",
  "number_of_retries": 3,
  "interval_between_retries": 15
}
'

import requests

url = "https://api.dialnexa.com/campaigns/{id}"

payload = {
    "sent_lead_count": "10",
    "picked_up_lead_count": "10",
    "success_lead_count": "10",
    "completed_leads": "10",
    "failed_leads": "10",
    "number_of_retries": 3,
    "interval_between_retries": 15
}
headers = {
    "x-organization-id": "<x-organization-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'x-organization-id': '<x-organization-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    sent_lead_count: '10',
    picked_up_lead_count: '10',
    success_lead_count: '10',
    completed_leads: '10',
    failed_leads: '10',
    number_of_retries: 3,
    interval_between_retries: 15
  })
};

fetch('https://api.dialnexa.com/campaigns/{id}', 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/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'sent_lead_count' => '10',
    'picked_up_lead_count' => '10',
    'success_lead_count' => '10',
    'completed_leads' => '10',
    'failed_leads' => '10',
    'number_of_retries' => 3,
    'interval_between_retries' => 15
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-organization-id: <x-organization-id>"
  ],
]);

$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/{id}"

	payload := strings.NewReader("{\n  \"sent_lead_count\": \"10\",\n  \"picked_up_lead_count\": \"10\",\n  \"success_lead_count\": \"10\",\n  \"completed_leads\": \"10\",\n  \"failed_leads\": \"10\",\n  \"number_of_retries\": 3,\n  \"interval_between_retries\": 15\n}")

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

	req.Header.Add("x-organization-id", "<x-organization-id>")
	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.patch("https://api.dialnexa.com/campaigns/{id}")
  .header("x-organization-id", "<x-organization-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"sent_lead_count\": \"10\",\n  \"picked_up_lead_count\": \"10\",\n  \"success_lead_count\": \"10\",\n  \"completed_leads\": \"10\",\n  \"failed_leads\": \"10\",\n  \"number_of_retries\": 3,\n  \"interval_between_retries\": 15\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dialnexa.com/campaigns/{id}")

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

request = Net::HTTP::Patch.new(url)
request["x-organization-id"] = '<x-organization-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"sent_lead_count\": \"10\",\n  \"picked_up_lead_count\": \"10\",\n  \"success_lead_count\": \"10\",\n  \"completed_leads\": \"10\",\n  \"failed_leads\": \"10\",\n  \"number_of_retries\": 3,\n  \"interval_between_retries\": 15\n}"

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

Overview

Endpoints - v1

Endpoints - Legacy

Code Examples And SDK Status

When to use this

Path parameters

Errors

Authorizations

Headers

Path Parameters

Body

Response

​When to use this

​Path parameters

​Errors

​Related endpoints

Authorizations

Headers

Path Parameters

Body

Response

When to use this

Path parameters

Errors

Related endpoints