Skip to main content
POST
Create broadcasts

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Create a broadcast — send one template to a list of contacts and/or a contact group. Scramble reads these rules to document the request body.

Mirrors the input keys the existing BroadcastsController::store accepts (broadcast_name / template_id / contacts[] / groups[] / device_id / schedule_type+send_date+send_time / timezone), exposed under public-facing names. At least one of recipients or group_id is required; provide schedule_at to schedule for later, omit it to send now.

name
string
required

Broadcast label shown in the dashboard. Required.

Maximum string length: 255
template_id
integer
required

Approved WaTemplate id to send to every recipient. Required.

group_id
integer | null

Contact-group id — every member is added as a recipient.

device_id
integer | null

Sending device id (optional — defaults to the workspace's primary device).

schedule_at
string | null

When to send — ISO 8601 / parseable datetime. Omit to send immediately.

Maximum string length: 64
timezone
string | null

IANA timezone for schedule_at (e.g. Asia/Kolkata). Defaults to UTC.

Maximum string length: 64
recipients
integer[] | null

Recipient contact ids. Required unless group_id is given.

Response

Resource created successfully.

data
any[]
required
meta
object
required