Skip to main content
POST

Authorizations

​
Authorization
string
header
required

Accepts either a raw API key or Bearer <key>.

Headers

​
revision
string

Optional dated API revision for the request. Must use YYYY-MM-DD format.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-03-01"

Body

application/json

Create an unscheduled, unlaunched broadcast draft. Audience, segment, trigger, schedule, send, launch, and lifecycle fields are not supported and are rejected with 422 Validation error.

​
name
string
required

Broadcast name. Trimmed before validation; must be non-blank.

Required string length: 1 - 255
​
channel
enum<string>
default:email

Messaging channel. Defaults to email when omitted. Supply the matching channel when the initial content is for sms or push.

Available options:
email,
sms,
push
​
message
object | null

Optional initial message. When present it initialises the server-provisioned default first message and default content.

​
labels
string[]

Labels to apply to the new broadcast. Each label is stored lowercased, must be non-blank, must not contain a comma, and must be at most 255 characters once lowercased.

Response

Broadcast draft created.

A broadcast: a one-off or recurring message sent to an audience.

​
id
integer
required
​
name
string
required

Broadcast name.

​
channel
enum<string>
required

Delivery channel.

Available options:
email,
sms,
push
​
schedule
object
required

Scheduling details for the broadcast. type indicates whether the broadcast is sent once or on a recurring schedule. Additional scheduling fields (such as scheduled_at, cron, next_scheduled_at, batches, and timezone_detection) may also be present.

​
status
enum<string>
required

Broadcast status. archived is returned for archived broadcasts on the detail endpoint.

Available options:
draft,
scheduled,
sending,
sent,
cancelled,
active,
paused,
archived
​
labels
string[]
required

Labels applied to the broadcast. Always present; [] when the broadcast has none. Labels are stored lowercased.

​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required