send a text message to a chat

post

https://waapi.app/api/v1/instances/{id}/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

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int64

required

Instance ID

Body Params

chatId

string

required

Chat ID: <number>@c.us or <lid>@lid for a contact (both address the same chat), <id>@g.us for a group.

message

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

replyToMessageId

string

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

previewLink

boolean

Defaults to true

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

firedandforget

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

`data.status` reports whether the action was carried out; on error `data` carries `message` and `explanation`. Payload: Message sent successfully.

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

`skipNumberCheck: true`), or when the connected account is under a reach-out restriction and this exact recipient has already been observed being rejected — contacts who replied are unaffected, and retrying counts towards the limit that caused the restriction. The `message` field names which of the two applies.

200Request reached the instance. data.status reports whether the action was carried out; on error data carries message and explanation. Payload: Message sent successfully.

429Refused by the instance's send protection. Nothing was sent; retry after the given number of seconds. Integrations that already handle 429 need no change.

`data.status` reports whether the action was carried out; on error `data` carries `message` and `explanation`. Payload: Message sent successfully.