Skip to main content
POST
Send Template to Customer
Put the customer’s ID in the URL, then send the template details in the request. For example, to send to customer 5, use /api/v1/contacts/5/messages.

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

Path Parameters

contact_id
integer
required

The customer's id.

Example:

1

Body

application/json
channel_id
integer

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

Response

202 Accepted

status
string
data
object