Skip to main content
POST
Start a campaign

Authorizations

Authorization
string
header
required

Use Authorization: Bearer tc_live_xxxxx

Headers

Idempotency-Key
string

Optional client-supplied idempotency key. When present, the gateway caches the response for 24 hours and returns the same response on retried requests with the same key (account-scoped). Safe for retries on network blips. Format: 8-255 ASCII characters from [A-Za-z0-9_-].

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

Idempotent replay. A run already exists for this Idempotency-Key

Returned instead of StartCampaignResponse when the request's Idempotency-Key matches a run already created for this campaign. No new run is created and total_leads is omitted.

run_id
string<uuid>
status
string
message
string
Example:

"Campaign run already exists with this idempotency key"