Skip to main content
PATCH
Update a dialer campaign

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Path Parameters

id
string
required

Campaign id.

Body

application/json
name
string

Campaign display name.

status
string

Target status: active, paused, completed, or aborted. Cannot transition away from 'aborted'.

pacing_ratio
number

0.8-3.0.

max_abandon_rate
number

FCC abandon-rate ceiling fraction.

target_service_level_seconds
number

5-120.

caller_id_e164
string

Must be owned by this org.

application_sid
string
agent_skills_required
array
call_script_id
string | null
recording_enabled
boolean

Enabling requires recording_consent_acknowledged=true in the same request unless already acknowledged.

amd_enabled
boolean
dispatch_mode
string

'human' or 'voice_agent'.

voice_agent_id
string | null

Null clears the agent; a string must reference an existing agent.

concurrency_limit
number

1-200.

voicemail_message_url
string | null
amd_sensitivity
string | null
preview_decision_seconds
number | null
metadata
object
retry_policy
object
caller_id_pool
array
caller_id_strategy
string
campaign_script
object
best_time_to_dial
boolean

Response

The updated campaign row.

The updated campaign row.

data
object
meta
object