Update scheduled message

Edit a previously-queued message that has not dispatched yet (status `pending`).

Accepts the same flat body fields as Schedule message — type, text, mediaUrl, mediaBase64, mediaKind, mediaFilename, pollQuestion, pollOptions, pollAllowMultiple, sendAt, replyTo, secret — but every field is optional. Send only the fields you want to change; at least one is required. The recipient is fixed at schedule time (it was the {chatId} path param) and cannot be changed here.

Notes:

A new mediaUrl / mediaBase64 is re-hosted to GCS just like on create; mediaKind / mediaFilename can be edited on their own.
Editing text re-derives the link-preview card (auto-attached when the text contains a URL).
sendAt reschedules (must be ≥10s in the future, ≤365 days).
Returns 400 once the message has advanced past the editable window (status not pending).

Request

curl -X PATCH "https://api.blueticks.co/v1/scheduled-messages/" \  -H "Content-Type: application/json" \  -d '{    "text": ""  }'

{
  "success": true,
  "data": {
    "id": "string",
    "waMessageKey": {
      "fromMe": true,
      "remote": "string",
      "id": "string",
      "_serialized": "string",
      "participant": "string"
    },
    "to": "string",
    "type": "text",
    "text": "string",
    "mediaUrl": "string",
    "mediaKind": "image",
    "pollQuestion": "string",
    "pollOptions": [
      "string"
    ],
    "pollAllowMultiple": true,
    "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",
    "secret": "string",
    "linkPreview": {
      "title": "string",
      "description": "string",
      "canonicalUrl": "string",
      "thumbnail": "string"
    }
  }
}

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

Path Parameters

id*string

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 @[Jon Daw](xxxxxxxxxxxx@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

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 correlation token you choose to tag this message with. It is stored on the message and carried into WhatsApp's messageSecret, so you can match it back to your own records later. NOT a deduplication key: sending the same secret twice creates two separate messages. To make retries safe (at-most-once send), use the Idempotency-Key header instead. When omitted, the API encodes the internal message id here for delivery-status matching — only set this if you have your own correlation scheme.

Length1 <= length <= 256

pollQuestion?string

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

Length1 <= length <= 255

pollAllowMultiple?boolean

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

pollOptions?array<>

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

Update scheduled message

Request

Path Parameters

Request Body

Response

Response Body

`application/json`

`application/json`

Update scheduled message

Request

Path Parameters

Request Body

Response

Response Body

200application/json

Error codesapplication/json

`application/json`

`application/json`