Skip to main content
POST
Send a WhatsApp message

Authorizations

Authorization
string
header
required

Tenant API key.

Body

application/json

The object matching kind is required (media for image, audio, video, document and sticker).

to
string
required

Recipient phone number or business-scoped user ID.

Required string length: 1 - 135
kind
enum<string>
required
Available options:
text,
template,
image,
audio,
video,
document,
reaction,
interactive,
location,
contacts,
sticker
phoneNumberId
string
Pattern: ^\d{1,32}$
text
object
template
object
media
object

Provide id or link. Audio: no caption/filename; voice only for audio. Video: no filename.

reaction
object
location
object
contacts
object[]
Required array length: 1 - 10 elements
interactive
object

Meta interactive object. Validated for type flow, location_request_message, cta_url, product, product_list and order_details.

replyToMessageId
string
Maximum string length: 256

Response

Meta accepted the message.

success
any
required
messageId
string
required

Meta's messages[0].id (the wamid). Empty when Meta returns none.

recipient
string
required

Meta's contacts[0].input; otherwise the phone number sent, without +, or the BSUID.

phoneNumberId
string
required

The number that sent the message.