Skip to main content
POST

Path parameters

string
required
Unique identifier of the bot sending the message.

Body parameters

string
required
Message type. Must be "text".
string
required
Message recipient. Accepts a phone number in E.164 format without the leading + (e.g. 593999999999) or a BSUID (e.g. US.13491208655302741918) for users who have enabled phone number privacy in WhatsApp. See Identifying the recipient.
string
required
Message content.
boolean
default:"true"
Send false so the links in the message arrive without the preview card. If you leave it out, WhatsApp shows the preview. Only applies to WhatsApp Cloud API and Gupshup CAPI; it is ignored on other channels and providers. See Link preview.

Response

boolean
true if the message was sent successfully.
string
Identifier of the sent message.
When a message includes a link, WhatsApp shows a card with the page’s title, description and image. With previewUrl: false the link is sent as plain text, without that card, so the user focuses on the message. It is the same Disable link preview option as in the Text node. The field goes at the root of the body, at the same level as text, and accepts true or false. Any other value returns a 422 error.
Body without link preview
Do not use the Meta API format ("text": { "body": "...", "preview_url": false }). In this endpoint text must be a string, so that body returns a 422 error.
previewUrl only applies to WhatsApp channels connected through WhatsApp Cloud API or Gupshup CAPI. On Instagram, Messenger and other WhatsApp providers the field is ignored.

Character limit by channel

Use Cases

  • Simple notifications
  • Confirmations
  • Informational messages
  • Basic automated responses
  • Links to payments, account statements or forms without a preview

Next steps

Text node

Disable the link preview from a workflow.

Message with Options

Send a text with selection buttons.