Skip to main content
POST
Create a broadcast draft

Authorizations

Authorization
string
header
required

Workspace API key, e.g. Authorization: Bearer cb_live_.... Create one in Settings → API Keys. See public_api.md § 3 for scopes.

Body

phone_number_id
integer
required

Phone number ID from GET /api/v1/phone-numbers/

template_id
integer
required

Template ID from GET /api/v1/templates/

template_params
object | null

Legacy template parameter overrides

template_variables
object | null

Per-contact template variable mapping (maps placeholder index to field/static value)

filter_tags
string[] | null

Recipient filter: contacts matching any of these tags

filter_conv_status
string | null

Recipient filter: conversation status (e.g. OPEN, CLOSED, PENDING)

segment_id
integer | null

Recipient filter: segment ID

list_id
integer | null

Recipient filter: contact list ID (takes precedence over segment_id and filter_*)

Response

{key}
any