Skip to main content
POST
Start a campaign

Authorizations

Authorization
string
header
required

Use Authorization: Bearer tc_live_xxxxx

Headers

Idempotency-Key
string

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.

Required string length: 8 - 255
Pattern: ^[A-Za-z0-9_-]+$
Example:

"a1b2c3d4-e5f6-7890-abcd-ef0123456789"

Path Parameters

campaign_id
string<uuid>
required

Campaign UUID

Response

Scheduled for a future schedule_time, inbound already running, or an Idempotency-Key that already created a run.

run_id
string<uuid> | null

The new run. null for inbound, absent for a scheduled start.

status
enum<string>
Available options:
running,
scheduled
total_leads
integer

Leads in the attached lists, counted at start. Absent for inbound.

schedule_time
string<date-time>

Present only on a scheduled start.

message
string
Example:

"Campaign started successfully"