Skip to main content
POST
Create scheduled messages

Authorizations

Authorization
string
header
required

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

Body

application/json

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
required

Schedule label. Required.

Maximum string length: 255
run_at
string
required

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

Maximum string length: 64
recipients
string[]
required

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

Minimum array length: 1
Maximum string length: 32
message
string | null

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

Maximum string length: 4096
template_id
integer | null

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

device_id
integer | null

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

timezone
string | null

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

Maximum string length: 64

Response

Resource created successfully.

data
any[]
required
meta
string
required