Skip to main content
POST
Send WhatsApp template message

Authorizations

Authorization
string
header
required

Use a Bearer token to access these API endpoints. Example: "Bearer {your-token}"

Body

application/json
agentId
string<uuid>
required

UUID of the Agent. Must exist and have WhatsApp configured.

Example:

"32d8fc98-be1e-4d32-a12e-146f397fb1cb"

templateId
string<uuid>
required

UUID of the approved WhatsApp template to send. You can get the templateId from the templates section.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

phoneNumber
string
required

Phone number of the recipient in E.164 format (e.g., +1234567890).

Example:

"+12345678900"

parameters
object

Optional object containing parameters to fill template placeholders. Keys should be field1, field2, etc. corresponding to {{1}}, {{2}}, etc. in the template. Omit this field if template has no placeholders.

Example:
header
object

Optional header media definition. Supports image, video, or document with a publicly accessible URL.

Response

Success

success
boolean

Indicates whether the request completed successfully. True for successful responses; false for documented error responses.

Example:

true

message
string

Human-readable response message. Safe to display in logs or simple client notifications; use structured fields for program logic.

Example:

"WhatsApp template message sent successfully"

data
object