Skip to main content
POST
Pause a campaign

Authorizations

Authorization
string
header
required

A workspace API token (sk_live_...) or an OAuth access token (oat_live_...). Create workspace tokens in Settings > API. Send either as Authorization: Bearer <token>.

Headers

Idempotency-Key
string

A unique value (a UUID works) that makes retrying this request safe. A repeat with the same key and body within 24 hours returns the original response instead of acting twice; the same key with a different body is a 409 idempotency_key_reused.

Maximum string length: 255

Path Parameters

campaign_id
string
required

Unique identifier for a campaign.

Pattern: ^camp_[0-9a-f]{32}$
Example:

"camp_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"

Response

Successful Response

An outbound campaign.

created_at
string<date-time>
required
id
string
required

Unique identifier for a campaign.

Pattern: ^camp_[0-9a-f]{32}$
Example:

"camp_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"

status
enum<string>
required

Where a campaign is in its lifecycle.

A campaign whose audience is still being assembled reads as draft until it is ready.

Available options:
draft,
scheduled,
running,
paused,
completed
updated_at
string<date-time>
required
instructions
string | null

How the AI should continue a conversation after a reply.

name
string | null
object
string
default:campaign
Allowed value: "campaign"