Skip to main content
POST

Authorizations

Authorization
string
header
default:App
required

This is the most secure authorization type and the one with the most flexibility.

API keys can be generated by calling the dedicated API method. Furthermore, API keys can have a limited scope and cover only some API methods. Lastly, they can be revoked at any time. This range of possibilities makes API keys well suited for separating the API access rights across multiple applications or use cases. Finally, the loss of an API key is easily manageable.

You can manage your API keys from GUI, or programmatically with dedicated API.

API key Authorization header example:

Body

application/json
from
string
required

Registered WhatsApp sender number. Must be in international format and comply with WhatsApp's requirements.

Required string length: 1 - 24
to
string
required

Message recipient number in international format or WhatsApp business-scoped user ID.

Required string length: 1 - 150
content
ContactsContent · object
required

The content object to build a message that will be sent.

messageId
string

The ID that uniquely identifies the message sent.

Maximum string length: 200
callbackData
string

Custom client data that will be included in a Delivery Report.

Maximum string length: 4000
notifyUrl
string

The URL on your callback server to which delivery and seen reports will be sent. Delivery report format, Seen report format.

Maximum string length: 2048
Pattern:
entityId
string

Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our documentation.

Maximum string length: 255
applicationId
string

Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our documentation.

Maximum string length: 255
context
MessageContext · object

Context object to define WhatsApp-specific metadata about a message.

Response

Message accepted for delivery

to
string

The destination address of the message.

Example:

"353861234572"

messageCount
integer<int32>

Number of messages required to deliver.

Example:

1

messageId
string

The ID that uniquely identifies the message sent. If not passed, it will be automatically generated and returned in a response.

Example:

"06df139a-7eb5-4a6e-902e-40e892210455"

status
SingleMessageStatus · object

Indicates the status of the message and how to recover from an error should there be any.