Update campaign description

The Update Campaign endpoint allows you to modify an existing campaign, including its dialing strategy, caller ID settings, local time restrictions, and redial rules.

Prerequisites

You must have access to your contact center API key.
A valid campaign must already exist in your contact center.

Making requests

The Update Campaign API uses a PATCH request. Request and response payloads are formatted as JSON, using UTF-8 encoding and URL-encoded values.

Authentication

The Update Campaign API requires the Base URL (cluster_id) and the contact center API key.

Available Fields

Field	Type	Description	Example	Notes
name	string	The name of the campaign.	Campaign (154)
strategy	string	The campaign strategy (`simple`, `predictive_ai`).	simple
dial_level	integer	Number of parallel attempts to dial per agent.	1
dial_level_override	object	Dial level override settings.		See Dial level override table.
max_dial_time	integer	Max seconds to dial a contact.	60
max_wait_time	integer	Max seconds to wait for agent after contact answers.	5
local_time_settings	object	Local time restrictions for calls.		See Local time settings table.
caller_id_sets	array	Caller ID sets used by the campaign.		See Caller ID sets table.
redial_rules	object	Rules for redial attempts based on call outcomes.		See Redial rules table.
answering_machine_detection	boolean	Whether AMD is enabled.	true
wrap_up_time	integer	Wrap-up time in seconds.	30
abandoned_ratio_threshold	float	Maximum abandoned ratio threshold.	0.05
status	string	Campaign status (`active`, `auto_paused`, `auto_pausing`, `completed`, `draft`, `import_error`, `paused`, `pausing`, `processing`, `stopped`, `stopping`).	active
timezone	string	Campaign time zone.	UTC

dial_level_override object

Field	Type	Description	Example
enabled	boolean	Whether override is active.	true
override_value	float	Dial level multiplier.	1.5
active_agents_threshold	integer	Minimum active agents before override applies.	3

local_time_settings object

Field	Type	Description	Example
call_from	string	Local start time (HH:MM).	08:00
call_to	string	Local end time (HH:MM).	22:00
week_days	array	Days of week allowed.	["Mon","Tue","Wed"]

caller_id_sets array

Field	Type	Description	Example
numbers	array	List of Caller IDs in the set.	["1234567890","0987654321"]

redial_rules object

Field	Type	Description	Example
machine_answer	object	Rules for calls answered by machines.	{"delay": 60, "attempts": 2 }
busy	object	Rules for busy signals.	{ "delay": 120, "attempts": 3 }
no_answer	object	Rules for no-answer outcomes.	{ "delay": 300, "attempts": 1 }
failed	object	Rules for failed calls.	{ "delay": 600, "attempts": 1 }

Example Request

{
  "name": "Updated Campaign Name",
  "strategy": "simple",
  "dial_level": 2,
  "max_dial_time": 45,
  "max_wait_time": 5,
  "max_dial_attempts": 3,
  "answering_machine_detection": true,
  "local_time_settings": {
    "call_from": "08:00",
    "call_to": "20:00",
    "week_days": ["Mon", "Tue", "Wed", "Thu", "Fri"]
  },
  "caller_id_sets": [
    { "numbers": ["1234567890", "0987654321"] }
  ],
  "local_caller_id": true
}

Responses

200 OK

Campaign was updated successfully.

{
  "uuid": "91f0f1a3-a622-4a02-b3f4-95df7bc16291",
  "name": "Updated Campaign Name",
  "status": "active",
  "strategy": "simple",
  "dial_level": 2
}

400 Bad Request

Returned when the request is invalid or contains incorrect parameters.

{
  "error": "Invalid campaign ID"
}

401 Unauthorized

Authentication failed. Check the Bearer token.

404 Not Found

The campaign does not exist.

500 Internal Server Error

Unexpected error occurred on the server.

Use Cases

Renaming a campaign.
Changing the campaign’s dialing strategy from progressive to predictive.
Adjusting redial rules and maximum attempts.
Enabling Answering Machine Detection.
Restricting call times to certain hours or weekdays.