Skip to main content
POST
Send a template message

Headers

x-api-key
string
required

API key needed to authorize the request

Body

application/json

The payload to send with the template message

variables
string[]
required
phone
string
required

Phone number to send the template to

template_name
string
required

Name of the template to send

contact_name
string
email
string<email>

Email of the contact

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
meta_data
object
stage_id
string
agent_id
string
from_phone_number
string

Phone number to send the template from

Variables for carousel cards

Response

Message sent successfully.