Skip to main content
PUT
Replace a campaign's disposition buttons
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

Replace-all body for a campaign's disposition buttons. A color key on a button is rejected with 400 — presentation always comes from the referenced tag.

buttons
object[]
required

The complete button set for the campaign. An empty array clears every button.

Response

The campaign's disposition buttons after the replace, ordered by display_order.

id
string

Button ID.

Example:

"15"

tag_id
string

Referenced call-tag ID.

Example:

"101"

outcome_kind
enum<string>

How the dialer treats a call dispositioned with this button.

Available options:
successful_positive,
successful_negative,
rescheduled,
unsuccessful_call_again,
unsuccessful_do_not_call
Example:

"rescheduled"

color
string | null

Colour of the referenced tag; null when unresolvable.

Example:

"#FFAA00"

display_order
integer

Ascending display position.

Example:

0

name
string | null

Display name of the referenced tag; null when unresolvable.

Example:

"Call back later"

outcome
string | null

Outcome of the referenced tag; null when unresolvable.

Example:

"rescheduled"