POST
Transactional WhatsApp
Send WhatsApp messages to one or more recipients using pre-approved templates. This endpoint supports personalization through parameterized_variables and event data.

Request Body

The request body must include the sender’s phone number, template details, and recipient information.
  • force_send: (Optional) A boolean flag to force send the WhatsApp message, bypassing duplicate message detection or sending limits (default is false).
  • parameterized_variables: An object containing key-value pairs used to replace dynamic variables or merge tags within the WhatsApp message body or template.
  • event: (Optional) Event-related data for tracking or triggering specific workflows.

Example Payloads

Send a message using a pre-approved WhatsApp template with custom parameters and event data.

Authorizations

Authorization
string
header
required

Use your API key with the 'Bearer ' prefix

Body

application/json

Send a message using a pre-approved WhatsApp template

from_number
string
required
type
enum<string>
default:template
required
Available options:
template
content
object
required
recipient
object[]
required
add_recipient_to_contacts
boolean
default:true

Add recipient to contacts

force_send
boolean
default:false

Force send message bypassing any limits or duplicate checks

parameterized_variables
object

An object containing key-value pairs used to replace dynamic variables or merge tags within the WhatsApp message body or template.

event
object
tags
string[]

Array of strings to tag the message with.

Response

WhatsApp message(s) sent successfully.