Skip to main content
POST
Send a message via WhatsApp

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

instanceId
string<uuid>
required

The WhatsApp instance UUID

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Body

application/json
to
string
required

Recipient phone number or chatId

type
enum<string>
required
Available options:
text,
image,
video,
audio,
document,
location,
template,
poll,
contact,
forward,
reaction
body
string
media_url
string
caption
string
template_name
string
template_params
object
location
object
quoted_message_id
string

Message ID to reply/quote

edit_message_id
string

Message ID to edit

mentions
string[]

@mentions (phone numbers with @c.us)

poll
object

Poll data (type=poll)

contacts
object[]

Contact cards (type=contact)

forward_message_id
string

Message ID to forward (type=forward)

reaction
string

Reaction emoji (type=reaction), empty string to remove

reaction_message_id
string

Message ID to react to (type=reaction)

Response

Message queued for delivery

message
string
required

Confirmation message

Example:

"Message queued for delivery"

jobId
string
required

BullMQ job ID for tracking

Example:

"42"