Skip to main content
POST
Send template message

Authorizations

X-API-Key
string
header
required

Preferred. API key value directly.

Query Parameters

channelId
string

Channel id. Auto-selects when omitted.

Example:

"ch_123"

to
string

Recipient phone or WhatsApp BSUID.

Example:

"919876543210"

templateName
string

Template name as synced for the channel.

Example:

"order_update"

languageCode
string

Template language, auto-resolved from stored template. Default en.

Example:

"YOUR_LANGUAGECODE"

variables
string

Body variables as comma list, e.g. variables=John,123.

Example:

"YOUR_VARIABLES"

body1
string

1st body variable (alternative to variables). body2..body20 continue.

Example:

"YOUR_BODY1"

header
string

Header text variable.

Example:

"YOUR_HEADER"

mediaUrl
string

Header media URL (pair with mediaType).

Example:

"YOUR_MEDIAURL"

mediaType
string

image | video | document.

Example:

"YOUR_MEDIATYPE"

Footer text variable.

Example:

"YOUR_FOOTER"

cards
any[]

Carousel templates only. Array (JSON string for GET) with one entry per card: { media, variables: string[], buttons: (string|null)[] }. media is an image/video URL, variables fill the card text {{n}}, buttons fill URL-button {{1}} values. Omitted values fall back to the template.

Example:
card1Media
string

Carousel templates only. Flat alternative to cards: card1Media, card1Var1, card1Button1 … (1-based).

Example:

"YOUR_CARD1MEDIA"

Body

application/json
to
string
required

Recipient phone or WhatsApp BSUID.

Example:

"919876543210"

templateName
string
required

Template name as synced for the channel.

Example:

"order_update"

channelId
string

Channel id. Auto-selects when omitted.

Example:

"ch_123"

languageCode
string

Template language, auto-resolved from stored template. Default en.

Example:

"YOUR_LANGUAGECODE"

variables
string

Body variables as comma list, e.g. variables=John,123.

Example:

"YOUR_VARIABLES"

body1
string

1st body variable (alternative to variables). body2..body20 continue.

Example:

"YOUR_BODY1"

header
string

Header text variable.

Example:

"YOUR_HEADER"

mediaUrl
string

Header media URL (pair with mediaType).

Example:

"YOUR_MEDIAURL"

mediaType
string

image | video | document.

Example:

"YOUR_MEDIATYPE"

Footer text variable.

Example:

"YOUR_FOOTER"

cards
any[]

Carousel templates only. Array (JSON string for GET) with one entry per card: { media, variables: string[], buttons: (string|null)[] }. media is an image/video URL, variables fill the card text {{n}}, buttons fill URL-button {{1}} values. Omitted values fall back to the template.

Example:
card1Media
string

Carousel templates only. Flat alternative to cards: card1Media, card1Var1, card1Button1 … (1-based).

Example:

"YOUR_CARD1MEDIA"

Response

Success. Envelope: { success:true, data, message? }.

success
boolean
required
Example:

true

data
any
message
string
pagination
object
total
number