Skip to main content
POST
Send a WhatsApp template

Authorizations

Authorization
string
header
required

Workspace API token created in Settings → API. Tokens start with adraa_.

Body

application/json
to
string
required

Recipient phone number in international format.

Maximum string length: 32
Example:

"+15551234567"

templateName
string
required

Name of an approved WhatsApp template in this workspace.

Maximum string length: 512
Example:

"order_status_update"

language
string
default:en_US

Template language code.

Example:

"en_US"

parameters
string[]

Values for the template's {{1}}, {{2}}, … placeholders, in order.

Maximum string length: 1024
Example:
headerImageUrl
string<uri>

Public image URL for a template that has a media (image) header.

Maximum string length: 2048
from
string

Which connected WhatsApp number sends: an account id or phone number. Optional when exactly one number is connected; required (as a disambiguator) when several are.

Maximum string length: 64
Example:

"+15559876543"

name
string

Display name applied only when this send creates the contact.

Maximum string length: 120
Example:

"Sara Ahmed"

Response

Template sent

conversationId
string

The WhatsApp conversation the template was sent on.

created
boolean

True when this send created a new contact/conversation.

message
object