Skip to main content
PUT
Replace a campaign's associations
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 associations. Each array is optional and defaults to empty, so an omitted kind clears that kind. Every entry may be given either as an object or as a bare id. Naming the same (kind, ref_id) twice in one body is rejected as a conflict.

target_tag
(object | integer)[]

Contact tags that define the campaign's membership. Naming a CRM-connection-owned tag re-ranks it in place; adding or removing such a tag is owned by the CRM connection, not this call.

One association in the replace-all body. priority and label are only accepted on target_tag entries.

queue_group
(object | integer)[]

Queue groups the campaign draws its agents from.

One association in the replace-all body. priority and label are only accepted on target_tag entries.

agent
(object | integer)[]

Agents (users) assigned to the campaign.

One association in the replace-all body. priority and label are only accepted on target_tag entries.

Response

The campaign's associations after the replace.

A campaign's associations, grouped by kind.

target_tag
object[]

Target-tag associations, each with its priority, label and origin.

queue_group
integer[]

Associated queue-group ids.

Example:
agent
integer[]

Associated agent (user) ids.

Example: