Start a campaign
Outbound: checks for attached lead lists with leads and enough credit, then creates a run and sets running (201). A future schedule_time sets scheduled instead (200), and the run starts then. Any status works unless a run is running or paused, so a stopped campaign can start again.
An Idempotency-Key retry within 24 hours replays the first response. Later, a key that already created a run returns that run (200).
Inbound: sets running with no run, lead or credit check (201, or 200 if already running).
Authorizations
Use Authorization: Bearer tc_live_xxxxx
Headers
Makes a retry safe. A 2xx response is stored for 24 hours per account, and a retry with the same key gets it back with Idempotent-Replay: true instead of running again. Errors aren't stored, so a retry after one runs fresh. The key isn't tied to a path or body: use a new key for every different request. A malformed key gets 400.
8 - 255^[A-Za-z0-9_-]+$"a1b2c3d4-e5f6-7890-abcd-ef0123456789"
Path Parameters
Campaign UUID
Response
Scheduled for a future schedule_time, inbound already running, or an Idempotency-Key that already created a run.
- Option 1
- Option 2
The new run. null for inbound, absent for a scheduled start.
running, scheduled Leads in the attached lists, counted at start. Absent for inbound.
Present only on a scheduled start.
"Campaign started successfully"