Skip to main content
PATCH
Update a dialer campaign
The Dialer is a newly released product surface: depending on your account’s rollout stage, campaigns managed through this API may not yet be visible in your CloudTalk Dashboard.

Authorizations

Authorization
string
header
required

HTTP Basic Authentication. Use your API Access Key ID as the username and your API Access Key Secret as the password. Generate keys in the CloudTalk Dashboard under Account -> Settings -> API Keys (https://dashboard.cloudtalk.io/menu/account/settings/API-keys).

Path Parameters

campaignId
string
required

Dialer campaign ID.

Pattern: ^[1-9][0-9]*$

Body

application/json

Body of the campaign update call. Every key is optional — an omitted key is left unchanged. status drives the lifecycle transition; deleted is never a valid target here (use the delete call).

name
string

Human-readable campaign name.

Maximum string length: 255
Example:

"Q3 renewals — EMEA"

mode
enum<string>

Dialing mode.

Available options:
sequential,
parallel
Example:

"parallel"

status
enum<string>

Target lifecycle status. Legal transitions: initializingactive | archived; activeinactive; activearchived; inactivearchived; archivedinactive. A patch that leaves the status unchanged is a no-op. deleted passes schema validation but is always rejected with 422 — only the delete call sets it.

Available options:
initializing,
active,
inactive,
archived,
deleted
Example:

"active"

calling_policy
object

Per-call behaviour bundle. Every knob is optional — an omitted knob keeps the service default. Stored verbatim, so a bundle read back may also carry knobs added by a newer release.

queue_policy
object

Allocation-batch and dynamic queue-sizing bundle. Every knob is optional.

retry_policy
object

Re-dial rules bundle. Every knob is optional.

schedule_policy
object

Campaign start-window bundle. Every knob is optional.

ttl_policy
object

Contact-eligibility expiry bundle — drives how long an allocated contact stays held. Every knob is optional.

waterfall_order
enum<string>[]

Ordered, duplicate-free subset of the waterfall categories. Contacts are served tier by tier in this order.

Available options:
favorite,
rescheduled,
retry,
fresh
Example:
agent_permissions
object

Booleans gating what an agent may do to their queue. Deny by default — an omitted key is false.

call_script_id
integer | null

Call script to link to the campaign; null clears the link, an omitted key leaves it unchanged. Sent as an integer in requests; responses return the id as a string.

Required range: x >= 1
Example:

310

survey_id
integer | null

Survey to link to the campaign; null clears the link, an omitted key leaves it unchanged. Sent as an integer in requests; responses return the id as a string.

Required range: x >= 1
Example:

44

Response

The updated campaign.

A dialer campaign. Identifiers are returned as strings because they are 64-bit integers server-side.

id
string

Campaign ID.

Example:

"42"

name
string

Human-readable campaign name.

Example:

"Q3 renewals"

mode
enum<string>

Dialing mode.

Available options:
sequential,
parallel
Example:

"sequential"

status
enum<string>

Lifecycle status. initializing: created, membership backfill pending. active: the only dialable state. inactive: paused, fully reversible. archived: review/analytics state, not dialable, exits only back to inactive. deleted: soft-deleted, terminal.

Available options:
initializing,
active,
inactive,
archived,
deleted
Example:

"active"

calling_policy
object

Per-call behaviour bundle. Every knob is optional — an omitted knob keeps the service default. Stored verbatim, so a bundle read back may also carry knobs added by a newer release.

queue_policy
object

Allocation-batch and dynamic queue-sizing bundle. Every knob is optional.

retry_policy
object

Re-dial rules bundle. Every knob is optional.

schedule_policy
object

Campaign start-window bundle. Every knob is optional.

ttl_policy
object

Contact-eligibility expiry bundle — drives how long an allocated contact stays held. Every knob is optional.

waterfall_order
enum<string>[]

Ordered, duplicate-free subset of the waterfall categories.

Available options:
favorite,
rescheduled,
retry,
fresh
Example:
agent_permissions
object

Booleans gating what an agent may do to their queue. Deny by default — an omitted key is false.

call_script_id
string | null

Linked call-script ID; null when none.

Example:

"310"

survey_id
string | null

Linked survey ID; null when none.

Example:

"44"

created_at
string<date-time>

Creation timestamp (ISO 8601, UTC).

Example:

"2026-08-01T09:15:00.000Z"

updated_at
string<date-time>

Last-update timestamp (ISO 8601, UTC).

Example:

"2026-08-04T11:42:07.000Z"

archived_at
string<date-time> | null

When the campaign entered archived; cleared on exit, so non-null only while the status is archived.

Example:

null

deleted_at
string<date-time> | null

Soft-delete timestamp; null unless the campaign has been deleted.

Example:

null