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

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Body

application/json
name
string
required

A label for the ad-hoc campaign this broadcast creates.

Maximum string length: 200
channel
enum<string>
required

The delivery channel for the broadcast.

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

The message body, with optional personalization placeholders.

Maximum string length: 4096
contact_ids
string[]

Explicit contact ids to message (max 50,000). Provide this OR filters.

filters
object

Segment filter AST resolving the audience server-side. Provide this OR contact_ids.

subject
string

Subject line, used for the email channel.

Maximum string length: 500
scheduled_at
string<date-time>

ISO 8601 time to send at. Omit to send immediately.

Response

Broadcast created and launched inline.

data
object
meta
object