Skip to main content
POST
Cancel a broadcast

Authorizations

Authorization
string
header
required

An org API key: Authorization: Bearer oak_….

Path Parameters

broadcast_id
string
required

Response

Successful Response

A queued template send. Counts are derived from the messages it produced, so they move as the worker fans the batch out; they always sum to requested.

id
string
required
template_id
string
required
template_name
string
required
template_language
string
required
channel_id
string
required
status
enum<string>
required

Derived campaign status shown in the UI. stopped_low_balance and cancelled mirror the stored state; the other two are computed from the counts (no stored value — chunked async means no single worker knows it sent the last recipient).

Available options:
in_progress,
completed,
stopped_low_balance,
cancelled
requested
integer
required
sent
integer
required
failed
integer
required
pending
integer
required
origin
string
required
created_at
string<date-time>
required