Broadcast
Send the same message to many contacts at once and track each broadcast's progress and per-recipient delivery.
httpAuthorizationBearer <token>status?stringapplication/json- response
data*array<string>meta*curl -X GET 'https://aexrux.com/api/v1/broadcasts'{ "data": [ "string" ], "meta": { "count": 0 }}httpAuthorizationBearer <token>application/json- body
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*stringBroadcast label shown in the dashboard. Required.
length <= 255template_id*integerApproved WaTemplate id to send to every recipient. Required.
group_id?|Contact-group id — every member is added as a recipient.
device_id?|Sending device id (optional — defaults to the workspace's primary device).
schedule_at?|When to send — ISO 8601 / parseable datetime. Omit to send immediately.
length <= 64timezone?|IANA timezone for schedule_at (e.g. Asia/Kolkata). Defaults to UTC.
length <= 64recipients?array<integer>|Recipient contact ids. Required unless group_id is given.
application/json- response
data*array<unknown>meta*curl -X POST 'https://aexrux.com/api/v1/broadcasts' \ -H 'Content-Type: application/json' \ -d '{ "name": "string", "template_id": 0}'{ "data": [ null ], "meta": { "broadcast_ids": "string", "devices_count": "string" }}httpAuthorizationBearer <token>id*integerapplication/json- response
data*array<unknown>meta*stringcurl -X GET 'https://aexrux.com/api/v1/broadcasts/0'{ "data": [ null ], "meta": "string"}httpAuthorizationBearer <token>id*integerapplication/json- response
data*array<>meta*curl -X GET 'https://aexrux.com/api/v1/broadcasts/0/recipients'{ "data": [ { "contact_id": 0, "status": "string", "error": "string", "wa_message_id": "string", "sent_at": "string", "delivered_at": "string", "read_at": "string" } ], "meta": { "count": 0, "stats": "string" }}httpAuthorizationBearer <token>id*integerapplication/json- response
data*array<unknown>meta*stringcurl -X POST 'https://aexrux.com/api/v1/broadcasts/0/stop'{ "data": [ null ], "meta": "string"}