Schedule message

The body is a FLAT object — set the type field to one of text, media, or poll; type selects which top-level fields are relevant.

Variants:

type: "text" — required text (1–4096 chars). A rich link-preview card is attached automatically when the text contains a URL. Example body:
```
{"type":"text","to":"+15551234567","text":"hello"}
```
type: "media" — provide the media as mediaUrl (HTTPS) or mediaBase64 (base64 / data: URL); mediaUrl wins if both are sent. The bytes are uploaded server-side and only a URL is sent on to the engine. Optional mediaKind (image · video · audio · document · sticker · voice · gif; auto-detected when omitted), text (caption), mediaFilename. Example:
```
{"type":"media","to":"+15551234567","mediaUrl":"https://cdn.example.com/x.pdf","mediaKind":"document","mediaFilename":"receipt.pdf"}
```
type: "poll" — required pollQuestion and pollOptions (2–12 items). Optional pollAllowMultiple (default false). Example:
```
{"type":"poll","to":"+15551234567","pollQuestion":"Pizza?","pollOptions":["Yes","No"]}
```

All variants accept optional sendAt (ISO 8601 ≥10s future, ≤365d) and replyTo (wire key of a prior message to quote).

See Sending messages for runnable Python / Node / PHP / cURL examples per variant.

Request

curl -X POST "https://api.blueticks.co/v1/scheduled-messages" \  -H "Content-Type: application/json" \  -d '{    "to": "+15555550100",    "type": "text",    "text": "Hello from Blueticks!"  }'

{
  "success": true,
  "data": {
    "id": "string",
    "key": "string",
    "to": "string",
    "type": "text",
    "text": "string",
    "mediaUrl": "string",
    "mediaKind": "image",
    "pollQuestion": "string",
    "status": "pending",
    "sendAt": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z",
    "confirmedAt": "2019-08-24T14:15:22Z",
    "receivedAt": "2019-08-24T14:15:22Z",
    "readAt": "2019-08-24T14:15:22Z",
    "playedAt": "2019-08-24T14:15:22Z",
    "failedAt": "2019-08-24T14:15:22Z",
    "failureReason": "string",
    "linkPreview": {
      "title": "string",
      "description": "string",
      "canonicalUrl": "string",
      "thumbnail": "string"
    }
  }
}

{
  "success": true,
  "data": {
    "id": "string",
    "key": "string",
    "to": "string",
    "type": "text",
    "text": "string",
    "mediaUrl": "string",
    "mediaKind": "image",
    "pollQuestion": "string",
    "status": "pending",
    "sendAt": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z",
    "confirmedAt": "2019-08-24T14:15:22Z",
    "receivedAt": "2019-08-24T14:15:22Z",
    "readAt": "2019-08-24T14:15:22Z",
    "playedAt": "2019-08-24T14:15:22Z",
    "failedAt": "2019-08-24T14:15:22Z",
    "failureReason": "string",
    "linkPreview": {
      "title": "string",
      "description": "string",
      "canonicalUrl": "string",
      "thumbnail": "string"
    }
  }
}

{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "string",
    "details": [
      {
        "path": "string",
        "code": "string",
        "message": "string"
      }
    ]
  }
}

Header Parameters

Idempotency-Key?string

Optional key for safe retries. Identical bodies with the same key return the original response; differing bodies return 409.

Lengthlength <= 64

Request Body

application/json

type*string

Value in"text" | "media" | "poll"

text?string

Text body (required for type=text) or optional media caption (type=media). Up to 4096 chars. Mention a contact inline with @[Display Name](<jid>), e.g. Hi @[Joni Naor](972544325389@c.us).

Lengthlength <= 4096

mediaUrl?string

Media source URL (https only). One of mediaUrl or mediaBase64 is required for media sends; mediaUrl wins when both are present.

Lengthlength <= 2048

mediaBase64?string

Raw media bytes, base64-encoded (or a data: URL). Used when mediaUrl is absent. For a file upload, send multipart/form-data with a mediaFile part instead — it is converted to this.

Lengthlength <= 15728640

mediaKind?string

Media kind (image · video · audio · document · sticker · voice · gif). Optional — auto-detected from the URL / content-type when omitted.

mediaFilename?string

Filename shown on the attachment (type=media). Optional — derived from the URL / uploaded file when omitted.

Length1 <= length <= 255

pollQuestion?string

Poll question (type=poll). Required for poll sends.

Length1 <= length <= 255

pollOptions?array<>

Poll options (type=poll). 2–12 items.

pollAllowMultiple?boolean

Allow selecting multiple poll options (type=poll). Default false.

to*string

sendAt?string

Formatdate-time

replyTo?string

Wire key of a prior message to quote-reply (from MessageResponse.key). Empty string = no reply.

Lengthlength <= 256

secret?string

Opaque caller id stored on the message secret and carried into the WhatsApp messageSecret.

Length1 <= length <= 256

Schedule message

Request

Header Parameters

Request Body

Response

Response Body

`application/json`

`application/json`

`application/json`

Schedule message

Request

Header Parameters

Request Body

Response

Response Body

200application/json

201application/json

Error codesapplication/json

`application/json`

`application/json`

`application/json`