Skip to main content
POST
whatsapp.template.send-configured

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
to
string
required

Recipient phone, personal data.

Pattern: ^\+[1-9]\d{1,14}$
templateKey
string
required

Your owned approved template key.

Required string length: 1 - 128
accountId
string

The sending account, from social.accounts.list. Optional when only one is connected.

Required string length: 1 - 256
params
string[]

Ordered text values.

Maximum array length: 50
Required string length: 1 - 1024
headerFileId
string

Id of an uploaded file holding template header media, in place of a public link.

Pattern: ^file_[0-9A-HJKMNP-TV-Z]{26}$
buttonValues
string[]

Ordered dynamic button values.

Maximum array length: 10
Required string length: 1 - 1024
cards
object[]

Carousel cards in approved order.

Required array length: 2 - 10 elements

Response

The result

status
string
required

Accepted for delivery.

Allowed value: "queued"
ref
string

Reference to what this call created. Pass it as ref to message receipt.