API Reference

send a text message to a chat

post
https://waapi.app/api/v1/instances//client/action/send-message

Send a text message to a chat. The chatId format varies depending on the chat type:

  • Individual chat: {phone_number}@c.us (e.g. [email protected])
  • Group chat: {group_id}@g.us (e.g. [email protected])
  • Channel/Newsletter: {channel_id}@newsletter (e.g. 123456789@newsletter)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

Instance ID

Body Params
string
required

Chat ID <countrycode_short>@c.us or @g.us for groups

string
required

Text message to send. Can include @123456789 for group chats.

mentions
array of strings

Optional array of contact IDs to mention. Only works in group chats. Make sure to include @123456789 in the message text.

mentions
string

Optional message ID to reply to. Format: {fromMe}{chatId}{messageId}

boolean
Defaults to true

Whether to show link previews in the message. Defaults to true.

boolean
Defaults to false

Set to true to process the request asynchronously. Returns a reference UUID for polling via GET /instances/{id}/request/{reference}. Alias: faf

Responses

401

Unauthorized — invalid or missing bearer token

403

Forbidden — insufficient permissions or account blocked

404

Not found — instance does not exist or does not belong to you

409

Conflict — instance is not ready

429

Too many requests — rate limit exceeded

Updated about 1 month ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago