Edit Settings for a Campaign

patch

https://dialpad.com/api/v2/powerdialer/campaignsettings/{campaign_settings_id}

Edit a Campaign Settings object

Path Params

campaign_settings_id

string

required

ID of the campaign settings

Body Params

agent_multiplier

integer

Defaults to 1

Number of items (calls) to process in parallel per agent

classification

string

enum

length ≤ 1500

Classification of the campaign, e.g. marketing

Allowed:

current_dial_rate

Dial rate used in predictive strategies when the rate changes throughout the campaign

custom_ivr_details_id

CustomIVR to play when a call is connected before the agent. References a CustomIvr from DP

dial_rate

integer

≤ 1000

Defaults to 1

Number of dials per minute based on escalation rate mainly used in ai agent dialing

enable_internal_dnc

boolean

Defaults to true

Enable internal DNC/DNT checks for this campaign

enable_national_dnc

boolean

Defaults to true

Enable national DNC/DNT checks for this campaign

enable_screen_pop

boolean

Defaults to false

Enable screen pop for this campaign

hours

object

Business hours specification

max_call_attempt_settings

object

Max call attempt settings

max_call_attempts

integer

Defaults to 0

DEPRECATED, use max_call_attempt_settings instead

max_sms_attempt_settings

object

Max sms attempt settings

playbook_id

Playbook to use. References a playbook from DP

post_bot_id

length ≤ 1500

Bot to execute when a LeadListItem completes - the item json (with resolved lead/contact/sms/call) is passed as template_data

screen_pop_fields

array of objects

length ≤ 10

Defaults to []

Ordered list of lead fields to show in the screen pop (max 10)

screen_pop_fields (unindexed)

timegate_settings

object

Time zone enforcement settings

timezone_mode

string

enum

Timezone mode to use for the timegate

Allowed:

Response

200Default Response