Skip to main content

Request

type must be text.

Field types

  • to: string (required)
  • type: string = text (required)
  • text: object (required)
  • text.body: string (required)
  • text.preview_url: boolean (optional)
  • tags: array of strings (optional)
  • metadata: object | string (optional)

Field behavior and limits

  • text.body is required.
  • text.body maximum length: 4096 characters.
  • URLs in text.body are automatically hyperlinked by WhatsApp clients.
  • text.preview_url is optional:
    • true: attempts to render a link preview for URLs in text.body.
    • false or omitted: no link preview is requested.

Response

Text sends are queued asynchronously.