Skip to main content
POST
Set type to choose what you send: The message is sent in the background. You get its id straight away. Use Get Message to see if it was delivered.

Authorizations

Authorization
string
header
required

Your API key. Create one under Setup → Developer API Keys and select the permissions this endpoint needs.

Scopes

messages:send

Body

application/json
type
enum<string>
required

template or text.

Available options:
template,
text
contact_id
integer
required

The customer's id.

channel_id
integer
required

The ID of the WhatsApp number you send from. Find it under endpoints in List Channels.

template_id
integer

The template's id. The template must be approved.

template_data
object

Values for the template's variables, if it has any.

idempotency_key
string | null

Optional. A unique value of your own. If you send the same request twice with the same key, the message is only sent once.

Maximum string length: 64
body
string

The text of your reply. Up to 4,096 characters.

Response

202 Accepted

status
string
data
object