API Reference

Update campaign

put deprecated
https://{defaultHost}/api/dialer/v1/campaigns/

Update campaign based on the Contact Center API key.
Update is not allowed if the campaign status is 'stopped' or 'completed'. Any attribute can be updated individually.

Path Params
integer
required

The unique identifier of the campaign.

Body Params
string

The name of the campaign.

string
enum

The campaign strategy type, predictive_ai available only if Dialer AI is enabled for contact center.

Allowed:
string
enum
Defaults to disabled

The order in which contacts are dialed for live campaigns, available only if the Dialing order feature is enabled for the contact center. Individual contact priority is ignored when dialing order is enabled.

Allowed:
integer

The number of parallel attempts to dial a contact for one available agent.

dial_level_override
object

Settings for overriding the dial level based on the number of active agents.

integer

The maximum time in seconds to spend dialing a contact.

integer

The maximum time in seconds to wait for an agent when a contact answers the call.

integer

The maximum number of attempts to dial a contact.

string

The name of an audio file that will be played as a voice message.

string | null

The name of an audio file that will be played when an answering machine is detected.

boolean
Defaults to false

Whether voicemail playback is enabled when an answering machine is detected.

boolean

Whether Answering Machine Detection is enabled for calls.

boolean

Whether or not the campaign type is live.

boolean
Defaults to false

The ability for contact to rate a call after the call ends.

local_time_settings
object

The time settings for calls, available only if Dialer contact local time is enabled for contact center.

caller_id_sets
array of objects

The Caller ID sets for the campaign.

caller_id_sets
boolean

Whether to use only Caller IDs that match the destination country or region.

redial_rules
object

The rules for redialing contacts based on call outcomes.

assigned_agents
array of strings

List of agent emails to add to the campaign.

assigned_agents
Responses

Updated 6 months ago

Did this page help you?
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 6 months ago

Did this page help you?