Skip to main content
POST
Launch a campaign

Authorizations

Authorization
string
header
required

API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). REST operations also require API Access for the credential's workspace. Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, loop:read, loop:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, billing:write, 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 within the workspace's available capabilities.

Path Parameters

id
string<uuid>
required

Campaign ID.

Body

application/json
compliance_attestation
boolean
required

Must be true: you confirm that the campaign complies with all laws and consent requirements that apply to the contacts being called, including do-not-call lists and opt-in rules (for example TCPA in the US, UWG and GDPR in the EU).

start_at
string<date-time> | null

ISO 8601 timestamp with a UTC offset, at least 5 minutes ahead, to schedule the start. null or absent starts the campaign now.

sequence_hash
string | null

The sequence_hash from GET /campaigns/{id}, passed unchanged (do not compute it; null for a campaign without a sequence). When the stored sequence differs, the launch fails with 409 sequence_changed. Omit to skip the check.

locale
enum<string>

Language of the confirmation wording that is stored. Defaults to the Accept-Language header, then en.

Available options:
en,
de,
fr,
es

Response

The campaign started or was scheduled.

data
object
required