Skip to main content
POST
Send a 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"

message
string
required

Message content to be sent

Example:

"Hello! This is a sample message from WhatsApp API."

sources
enum<string>
required

Messaging channel to use

Available options:
whatsapp cloud api,
whatsapp coex
imageUrl
string

Image URL — if provided, sends an image message instead of text

Example:

"https://example.com/image.jpg"

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

Message sent successfully

data
object