Skip to main content
POST
Send a template message with unstructured data

Path Parameters

templateId
string
required

The template ID of the message to be sent

Query Parameters

x-api-key
string
required

API key needed to authorize the request

stage
string

The stage id to send the message to

from-phone-number
string

The channel phone number to send the message from

Body

The payload to send with the template message. Can be JSON or form data. To add integration data use the key integrationData and the value should be a JSON object with the following structure: { "integrationContactId": "value", "integrationDealId": "value", "additionalData": { "key": "value" } }

The body is of type object.

Response

Message accepted for delivery. Use messageId with GET /public/whatsapp/message/status/{messageId} to track the delivery status. Retrying the exact same request within 10 minutes does not send a second message: it returns the response of the original request, so webhook retriers such as Klaviyo, Zapier or Make cannot duplicate a send. To intentionally message the same recipient twice, change the body or wait past the window.