Update a campaign
update_campaignEdit a campaign's settings. A draft accepts every setting; a scheduled or paused campaign accepts name, from_number_ids, calling windows and zone, retry policy, concurrency, ends_at and language (and scheduled_start_at while scheduled). A running campaign accepts no edits until it is paused. Returns the campaign and the list of changed fields.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | ||
| ends_at | No | ||
| purpose | No | ||
| agent_id | No | ||
| contacts | No | Replacement audience, created as a new list inside the edit (drafts only). | |
| language | No | ||
| time_zone | No | IANA time zone (default UTC), matched and stored like a contact's time_zone: ignoring case, another spelling of a zone stored as the zone it names, an offset such as UTC-5 refused. | |
| campaign_id | Yes | ||
| retry_policy | No | ||
| consent_basis | No | ||
| time_zone_mode | No | ||
| calling_windows | No | ||
| contact_list_id | No | ||
| from_number_ids | No | ||
| max_concurrency | No | ||
| organization_id | No | Optional. Defaults to the authenticated workspace; when supplied it must be that workspace's id. | |
| contact_list_name | No | ||
| scheduled_start_at | No | ||
| contact_list_source | No | How the replacement audience was collected; recorded on the new list. Defaults to csv. | |
| retry_policy_preset | No | ||
| reserved_concurrency | No |