Skip to Content
My App
Api

Scheduled

Schedule a WhatsApp send for a future time, list upcoming scheduled messages, and cancel one before it goes out.

GET /api/v1/scheduled — list the workspace's scheduled messages

GET
/scheduled

Authorization

http
headerAuthorizationBearer <token>

Response Body

application/json
  1. response
data*array<string>
meta*
Example Request
curl -X GET 'https://aexrux.com/api/v1/scheduled'
Example Response200
{  "data": [    "string"  ],  "meta": {    "count": 0  }}

POST /api/v1/scheduled — schedule a send (template/message + recipients + run_at)

POST
/scheduled

Authorization

http
headerAuthorizationBearer <token>

Request Body

application/json
  1. body

Schedule a WhatsApp send for later. Scramble reads these rules to document the request body. Mirrors the input keys the existing QueueController::scheduleMessage accepts (name / message / template_id / recipients / send_at / timezone / device_id), exposed under public-facing names. A template OR a message body is required.

name*string

Schedule label. Required.

Lengthlength <= 255
message?|

Body text (required unless a template_id is given). Max 4096 chars.

Lengthlength <= 4096
template_id?|

WaTemplate id to send instead of free text (optional).

device_id?|

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

run_at*string

When to send — ISO 8601 / parseable datetime interpreted in timezone. Required.

Lengthlength <= 64
timezone?|

IANA timezone for run_at (e.g. Asia/Kolkata). Defaults to the workspace timezone.

Lengthlength <= 64
recipients*array<>

Recipient phone numbers in international format. At least one required.

Items1 <= items

Response Body

application/json
  1. response
data*array<unknown>
meta*string
Example Request
curl -X POST 'https://aexrux.com/api/v1/scheduled' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "run_at": "string",  "recipients": [    "string"  ]}'
Example Response
{  "data": [    null  ],  "meta": "string"}

GET /api/v1/scheduled/{id} — one scheduled message

GET
/scheduled/{id}

Authorization

http
headerAuthorizationBearer <token>

Path Parameters

id*integer

Response Body

application/json
  1. response
data*array<unknown>
meta*string
Example Request
curl -X GET 'https://aexrux.com/api/v1/scheduled/0'
Example Response
{  "data": [    null  ],  "meta": "string"}

DELETE /api/v1/scheduled/{id} — cancel a future scheduled message

DELETE
/scheduled/{id}

Authorization

http
headerAuthorizationBearer <token>

Path Parameters

id*integer

Response Body

application/json
  1. response
data*array<unknown>
meta*string
Example Request
curl -X DELETE 'https://aexrux.com/api/v1/scheduled/0'
Example Response
{  "data": [    null  ],  "meta": "string"}

Message

Send a single message on ANY connected channel — WhatsApp (default), Facebook Messenger, Instagram or Telegram — by setting `channel` and `to` (phone / PSID / IGSID / chat_id). Text, media (image / video / document / audio) or a location pin; a file can be attached directly as a multipart `media` field or referenced by a public URL. Then read a message's delivery status or your history. Note: Facebook, Instagram and Telegram only accept a business-initiated message inside the platform's reply window (the customer must have messaged you first).

Template

Create, list and manage your approved WhatsApp templates, and send a template to one number with your own header, body variables and button values. Use this for utility / marketing sends that need a pre-approved template — including one with a PDF / document header (pass the file's public URL as the header, e.g. from the Media endpoint).