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

stageId
string

The stage id to send the message to

from-phone-number
string

The channel phone number to send the message from

Body

application/json

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" } }

Example:

Response

Message sent successfully.