Skip to main content
POST
Stop 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

Campaign stopped

status
enum<string>

The campaign's own status becomes completed.

Available options:
stopped
run_id
string<uuid> | null

The stopped run. Absent when no run was active, which is always the case for inbound.

message
string
Example:

"Campaign stopped successfully. Queued calls are being cancelled."