v1

latestOpenAPI 3.0.02026-07-2612645160.3 KB
WhatsApp Message

Send a template message

Send a specific template message to a given phone number. Optionally group sends into a campaign by passing a "campaign" object ({ id, name? }): the id is your own campaign identifier and every message sent with the same id is attributed to the same campaign (created automatically on first use; name updates use last-write-wins).

post/api/public/whatsapp/message/send/{phone}/template/{templateId}

Path parameters

templateIdstring required

The template ID of the message to be sent

phonestring required

The phone number to send the message to

Query parameters

from-phone-numberstring

Headers

x-api-keystring required

API key needed to authorize the request

Request body

contactNamestring
emailstring email

Email of the contact

variablesstring[] required
meta_dataobject
stageIdstring
autoAssignboolean

Whether the sender should be auto-assigned to the contact

toPhoneNumberstring
agent_idstring uuid

Agent ID to assign to the contact

Response

Message sent successfully.