API Reference

Partially update campaign

patch
https://{defaultHost}/api/v4/campaigns/

Partially updates a campaign. Cannot update campaigns with status stopped or completed. Only provided fields are updated.

Path Params
integer
required

The unique identifier of the campaign.

Body Params
string
length ≤ 100

The name of the campaign. Must be unique within the contact center.

string
enum

Dialing strategy for the campaign. predictive_ai is only available if Dialer AI is enabled for the contact center.

Allowed:
float
1 to 6

Number of simultaneous call attempts per available agent.

dial_level_override
object

Dial level override configuration.

integer
1 to 600

Maximum time in seconds to spend dialing a contact before hanging up.

integer
0 to 3600

Maximum time in seconds to wait for an available agent when a contact answers.

integer
1 to 99

Maximum number of attempts to dial a contact.

integer | null

Identifier of the voice message to play. Must reference an existing voice message in the contact center.

boolean

Whether answering machine detection is enabled for calls.

live
object | null

Configuration for adding leads to the campaign while it is running.

caller_id_sets
array of objects
length between 1 and 20

Sets of caller IDs used for outbound calls. Maximum 20 sets.

caller_id_sets
boolean

Whether to use only caller IDs matching the contact's country or region.

boolean

Whether ASR (Answer Seizure Ratio) optimization is enabled.

post_call_rating
object | null

Post-call survey configuration.

contact_local_time
object | null

Time restrictions for calling contacts based on their local time. Only available if the contact local time feature is enabled for the contact center. Set to null to clear.

follow_up_rules
object | null

Rules for redialing contacts based on call disposition. Each disposition can have up to 20 rules.

Responses

Updated 22 days ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 22 days ago