Skip to main content
POST
Send a template message

Authorizations

x-api-key
string
header
required

API key for authentication. Create one in Settings > Developer.

Body

application/json
to
string
required

Destination phone number in full international format, including the country code and without a leading + — for example 6281234567890 (Indonesia) or 60123456789 (Malaysia). A number in local format that starts with 0 is only resolved when countryCode is sent as well.

Example:

"6281234567890"

template_name
string
required

Identifier of the approved WhatsApp template to send. Despite the field name, this is the template's id, not its display name: use a bitCRM template id when template_source is CRM, or a bitLogin template id when it is AUTH.

Example:

"3f7c1e28-9b4a-4c31-8f2d-6a5e0b71d9c4"

template_source
enum<string>
required

Template source — CRM for business templates, AUTH for OTP

Available options:
CRM,
AUTH
sources
enum<string>

Messaging channel to use

Available options:
whatsapp cloud api,
whatsapp coex
params
string[]

Values for the template body placeholders, substituted in the order they appear in the template. The array must match the placeholder sequence exactly.

Example:
mediaUrl
string

Custom media URL for media templates — overrides the template default

ignoreActiveTicket
boolean
default:false

If true, skip sending when the chat is actively handled by an agent

countryCode
string | null

ISO 3166-1 alpha-2 country code. Used only as a fallback when to is in local format; it is ignored when to already carries a country code. Supported values: ID, SG, MY, TH, VN, PH, MM, KH, LA, BN, TL. Prefer sending to in full international format instead of relying on this field.

Example:

"ID"

Response

Template message sent successfully

data
object