GuidesAPI EndpointsKnowledge BaseSupportTalkdesk WebsiteMarketplaceDiscussionsDevelopers Blog
API Endpoints

Patch Campaign

patch https://api.talkdeskapp.com/campaigns/

For an account

📘

Supported Regions and Base URLs

👍

Access and Registration

Authentication

Scope

campaigns:write

Body Request - Example

{
  "op": "REPLACE",
  "path": "status",
  "value": "paused"
}

Body Response - Schema

200 (campaign updated successfully)

ParameterTypeDescriptionRequired
_linksobjectHAL API related links. "_links" subdivides into:

1 - "self" (object) - link to fetch the detail of the campaign. Required.
1.1 - "href" (string) - address of the resource. <= 2083 characters. 3 - "id" (string)

2 - "campaigns" (object) - link to fetch a list of all the campaigns. 3 - "id" (string)
2.1 - "href" (string) - address of the resource. <= 2083 characters. 3 - "id" (string)

3 - "id" (string) - <= 36 characters. Required.

4 - "name" (string) - <= 36 characters. Required.

5 - "dialing_mode" (string) - <= 35 characters. Allowed values: "PREDICTIVE", "PREVIEW"

6 - "priority" (integer) - >= 1; <= 10

7 - "run_once" (boolean)

8 - "action_required" (boolean)

9 - "status" (boolean) - <= 35 characters. Allowed values: "INCOMPLETE", "READY",
"RUNNING", "PAUSED"

10 - "dialing_mode_configuration" (object)
10.1 - "answering_machine_detection" (boolean) - the flag to decide if disconnects calls that reach answering machines or voicemails.
10.2 - "max_abandonment_rate" (integer) - maximum rate of abandoned calls. >= 1; <= 100
10.3 - "max_dialing_ratio" (integer) - maximum number of calls launched per agent. >= 1; <= 3
10.4 - "max_ring_time_in_secs" (integer) - the time in which if the calls are not answered, they are disconnected. >= 6; <= 120. Required.
10.4.1 - "abandonment_timeout" (object)
10.4.1.1 - "amount" (integer) - the time in which automatically hangs up answered calls that haven't been connected to an agent. Unit in seconds. >= 2; <= 30. Required.

11 - "dialing_strategy" (object)
11.1 - "max_skip_attempts" (integer) - the maximum number of times that an agent can skip a call.
>= 0
<= 20
11.2 - "strategy_type" (string) - the strategy on how the records will be dialed.
<= 35 characters
Allowed values:
"AUTOMATIC", "MANUAL"
11.3 - "preview_timeout" (integer) - the time in seconds that the preview context will be available to the agent.
>= 6
<= 300
11.4 - "max_attempts" (integer) - the maximum number of non-final call attempts each record may receive. >= 1;
<= 100. Required.
11.5 - "retry_period" (integer) - time between non-final call attempts. >= 1; <= 2592000. Required.
11.6 - "retry_time_unit" (string) - the time unit for the retry_period. <= 35 characters. Allowed values: "SECONDS",
"MINUTES", "HOURS", "DAYS". Required.
11.7 - "calling_hours" (array[object]) - set of rules to be applied based on location of the records lists. Required.
11.7.1 - "from" (string) - <= 35 characters. Required.
11.7.2 - "to" (string) - <= 35 characters. Required.
11.7.3 - "week_days" (array[string]) - Allowed values: "MONDAY",
"TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY",
"SATURDAY", "SUNDAY". Required.
11.8 - "dispositions" (object) - system dispositions to be available for defined campaign. Required.
11.8.1 - "busy" (object) - busy disposition settings. Required.
11.8.1.1 - "status_after_call" (string) - <= 35 characters. Allowed values: "FINAL", "RETRY". Required.
11.8.1.2 - "status_after_call" (string) - <= 35 characters. Allowed values: "FINAL", "RETRY". Required.
11.8.1.3 - "custom" (boolean). Required.
11.8.1.4 - "max_attempts" (integer) - >= 1; <= 100
11.8.1.5 - "retry_period" (integer) - >= 1;
<= 2592000
11.8.1.6 - "retry_period_time_unit" (string) - <= 35 characters. Allowed values: "SECONDS",
"MINUTES", "HOURS",
"DAYS".
11.8.2 - "no_answer" (object) - no_answer disposition settings. Required.
11.8.2.1 - "status_after_call" (string) - <= 35 characters. Allowed values: "FINAL", "RETRY". Required.
11.8.2.2 - "custom" (boolean). Required.
11.8.2.3 - "max_attempts" (integer) - >= 1; <= 100
11.8.2.4 - "retry_period" (integer) - >= 1;
<= 2592000
11.8.2.5 - "retry_period_time_unit" (string) - <= 35 characters. Allowed values: "SECONDS",
"MINUTES", "HOURS",
"DAYS".
11.8.3 - "abandoned" (object) - abandonment disposition settings.
11.8.3.1 - "status_after_call" (string) - <= 35 characters. Allowed values: "FINAL", "RETRY". Required.
11.8.3.2 - "custom" (boolean). Required.
11.8.3.3 - "max_attempts" (integer) - >= 1; <= 100
11.8.3.4 - "retry_period" (integer) - >= 1;
<= 2592000
11.8.3.5 - "retry_period_time_unit" (string) - <= 35 characters. Allowed values: "SECONDS",
"MINUTES", "HOURS",
"DAYS".
11.8.4 - "answering_machine_detection" (object) - answering_machine_detection disposition settings
11.8.4.1 - "status_after_call" (string) - <= 35 characters. Allowed values: "FINAL", "RETRY". Required.
11.8.4.2 - "custom" (boolean). Required.
11.8.4.3 - "max_attempts" (integer) - >= 1; <= 100
11.8.4.4 - "retry_period" (integer) - >= 1;
<= 2592000
11.8.5.5 - "retry_period_time_unit" (integer) - <= 35 characters. Allowed values: "SECONDS",
"MINUTES", "HOURS",
"DAYS".
11.8.6 - "invalid_number" (object) - invalid number disposition setting.
11.8.6.1 - "status_after_call" (string) - <= 35 characters. Allowed value: "FINAL". Required.
11.9 - "record_chain" (array[object]) - set of rules to be applied based on the phone type. Must have exactly one of each phone type (see type enum).
11.9.1 - "type" (string) - phone type. Allowed values: "HOME", "OFFICE", "MOBILE",
"EXTRA_1", "EXTRA_2",
"EXTRA_3"
11.9.2 - "max_attempts" (integer) - >= 1; <= 100. Required.
11.9.3 - "retry_period" (integer) - time between call attempts for phones of this type. >= 1;
<= 2592000
11.9.4 - "retry_period_time_unit" (integer) - <= 35 characters. Allowed values: "SECONDS",
"MINUTES", "HOURS",
"DAYS".
11.10 - "lists_sorting_criteria" (string) - the config on how the records will be sorted. <= 10 characters.
Allowed values: "FIFO",
"LIFO"

12 - "created_at" (string
(date-time))		yes

400 (errors were found in the submitted data), 401 (unauthorized), 403 (forbidden), 404 (campaign not found), 422 (unprocessable entity)

ParameterTypeDescriptionRequired
codestringn/ayes
messagestringn/ayes
descriptionstringn/ano
fieldsarray[object]"fields" subdivides into:

"name" (string)

"description" (string)		yes (name and description)

❗️

API Availability

The Campaign Management API is only available for customers enrolled in Talkdesk's Early Access (EA) program.
To enter the EA program, contact a Customer Success Manager.

The Campaign Management APII has been in EA since November 2022.

🚧

Troubleshooting

If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.

Language
Credentials
Header
Click Try It! to start a request and see the response here!