Skip to main content
PATCH
Update a campaign

Authorizations

Authorization
string
header
required

API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access.

Path Parameters

id
string<uuid>
required

Campaign ID.

Body

application/json

Partial update — only the provided fields are changed. At least one valid field is required.

name
string
assistant_id
string<uuid> | null
concurrency
integer

Max parallel campaign calls (1–10). Effective slots also respect plan max_parallel_calls.

Required range: 1 <= x <= 10
retry_max
integer
Required range: x >= 0
retry_delay_minutes
integer
Required range: x >= 1
calling_windows
object

Allowed calling windows per weekday, local to the campaign timezone. Keys: monsun; each value is an array of ["HH:MM", "HH:MM"] start/end pairs (24h). An empty array or missing key blocks the whole day.

timezone
string
amd_enabled
boolean
voicemail_action
enum<string>
Available options:
hangup,
drop_message
voicemail_message
string | null

Response

The updated campaign.

data
object
required