Skip to main content
PATCH
Update a campaign

Authorizations

Authorization
string
header
required

Your workspace secret key, sk_live_ followed by 32 hex characters. Create one in the console under Developers.

Path Parameters

campaign_id
string
required

The campaign's id (cmp_…).

Body

application/json
always_on
boolean
archived
boolean

true archives the campaign, false restores it. Status, contacts and settings are unchanged either way. null is rejected.

budget_paise
integer
caller_id_max_per_hour
integer
caller_ids
string[]
caller_name
string
dial_cps
number
end_date
string
final_results
boolean
max_concurrent
integer
max_duration_secs
integer
name
string
phone_number_id
string | null

One of your phone numbers (GET /v2/phone-numbers) that every call of this campaign rings from, through its own provider connection. null clears it. Exclusive with caller_ids.

pool_id
string | null

One of your phone pools (GET /v2/phone-pools): each contact rings from the number the pool picks. null clears it. Exclusive with phone_number_id and caller_ids.

re_attempt_period_secs
integer
retry_count
integer
skip_called_before
boolean
slots
object[]
start_date
string
tier
string
webhook_url
string
worker_pool
string[]

Response

Updated