Skip to main content
POST

Authorizations

Authorization
string
header
required

API key from Developer dashboard (Bearer token).

Body

application/json
account_id
integer
required

A connected WhatsApp number (social account id).

to
string
required

Recipient phone in E.164 (e.g. +14155551234).

type
enum<string>
default:text
Available options:
text,
media,
template,
interactive_buttons,
interactive_list,
location,
contacts,
reaction
context_message_id
string

A prior WhatsApp message id (wamid) to thread this message as a reply under, or (for type=reaction) the message being reacted to. Renders as a quoted reply in the customer's app.

text
string

Body for type=text, or the prompt text for type=interactive_buttons/interactive_list.

media
object

For type=media.

template
object

For type=template.

buttons
object[]

For type=interactive_buttons. Up to 3 reply buttons; the customer's tap arrives as an inbound message you already receive on your webhook.

Maximum array length: 3
button_text
string

For type=interactive_list. Label on the button that opens the list, max 20 characters.

sections
object[]

For type=interactive_list. Up to 10 rows total across all sections.

location
object

For type=location.

contacts
object[]

For type=contacts. WhatsApp's raw contact-card array - see Meta's WhatsApp Cloud API contacts message reference for the full object shape (name, phones, emails, etc.).

emoji
string

For type=reaction. The emoji to react with, or an empty string to remove a previously-sent reaction. Requires context_message_id.

Response

Sent

The response is of type object.