Skip to main content
POST
Send message

Authorizations

Authorization
string
header
required

Scoped API key created via POST /api/account/keys.

Path Parameters

session
string
required

Session name

Body

application/json

Message payload

chatId
string
required

Target chat JID (e.g. "5511999@s.whatsapp.net", "120363...@g.us", or "status@broadcast")

Example:

"1234567890@s.whatsapp.net"

type
enum<string>
required
Available options:
text,
image,
file,
voice,
video,
poll,
location,
contact
address
string

Human-readable address text (type=location)

Example:

"San Francisco, CA"

base64
string

Base64-encoded media bytes (alternative to url)

caption
string

Caption text for media messages (image, video, document)

Example:

"Check this out"

filename
string

Original filename for document messages

Example:

"photo.jpg"

isForwarded
boolean

Whether the message should be marked as forwarded

latitude
number

Latitude coordinate in degrees (type=location)

Example:

37.7749

longitude
number

Longitude coordinate in degrees (type=location)

Example:

-122.4194

mentions
string[]

JIDs to mention/tag in the message text

mimeType
string

MIME type of the media (e.g. "image/jpeg", "application/pdf")

Example:

"image/jpeg"

pollMultiSelect
boolean

Whether recipients can select multiple poll options

pollOptions
string[]

Array of answer options for the poll

Example:
pollTitle
string

Poll question text (type=poll)

Example:

"What's your favorite color?"

ptt
boolean

Whether the audio is a push-to-talk voice note (type=voice only)

quotedMessage
object
text
string

Text content (type=text)

Example:

"Hello, world!"

url
string

HTTP(S) URL of media to send (type=image, file, voice, video)

Example:

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

vcard
string

vCard-formatted contact data (type=contact)

Response

OK

fromLid
string

LID of the target chat

fromPhoneNumber
string

Phone number of the target chat (if available)

id
string

Message ID assigned by WhatsApp

mediaId
string

Media record ID (present when message contained media)

senderLid
string

LID of the sender (session account)

senderPhoneNumber
string

Phone number of the sender (if available)

status
string

Delivery status: pending, sent, delivered, read

timestamp
string

When the message was accepted by WhatsApp