Send a WhatsApp template message to an existing conversation.

Sends an approved template into a conversation that already runs on WhatsApp. This is the only way to write
into a WhatsApp conversation through the API: POST /v2/conversations/{conversation_id}/messages rejects
WhatsApp conversations with conversation_channel_not_supported. A template also reopens the 24 hour
customer service window when the contact has been silent, which plain messages cannot do.

The conversation must be a WhatsApp conversation and must not be frozen. The template must belong to the
same WhatsApp Business Account (WABA) as the number of the conversation, and must be text-only.

account_id is the account the template is sent as, recorded as the author of the message in the Customerly
inbox. It defaults to the account owning the access token. The assignee of the conversation is left untouched.

Example request

{
  "whatsapp_template_id": 42,
  "parameters": {
    "name": "John",
    "order_id": "A-19822"
  }
}
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
\d+

The conversation id

Body Params
integer
required

Identifier of the template to send, as returned by GET /v2/whatsapp/templates

integer | null

The account the template is sent as: it is recorded as the author of the message in the Customerly inbox and drives the send attribution. The contact only sees the WhatsApp business number, never the account. Defaults to the account owning the access token.

parameters
object

Values for the template variables, keyed by variable name. All the variables listed in required_variables must be provided.

Responses

401

Authentication required

402

The WhatsApp feature is not available on the current plan

403

Permission denied

404

Conversation, account, template or WhatsApp number not found

422

Validation failed

500

Internal server error

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json