Skip to main content
POST
Send an ad-hoc broadcast to a selected audience

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

Idempotency-Key
string

Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.

Required string length: 1 - 255
X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests — see Test mode explained for the full credential-header matrix and worked samples. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Body

application/json
contact_ids
string[]

Explicit contact ID list; mutually exclusive with filters.

filters
object

Segment filter AST selecting the audience; mutually exclusive with contact_ids.

name
string

Name of the created broadcast campaign (max 200 chars).

channel
enum<string>

Channel the message is sent on.

Available options:
sms,
whatsapp,
rcs,
viber,
email,
messenger,
instagram,
voice
message_template
string

Message body delivered to every resolved recipient (max 4,096 chars).

subject
string

Subject line; used for email broadcasts (max 500 chars).

scheduled_at
string

Optional ISO 8601 datetime; when set the broadcast starts then instead of immediately.

Response

The created campaign descriptor (data: { campaign_id, status }) in the standard { data, meta } envelope.

The created broadcast campaign, wrapped in the standard { data, meta } envelope.

data
object
meta
object