---
title: "send a text message to a chat"
method: POST
path: "/instances/{id}/client/action/send-message"
tags: ["message"]
---

# send a text message to a chat

`POST /instances/{id}/client/action/send-message`

## Request

- Base URL: `https://waapi.app/api/v1`
- URL: `https://waapi.app/api/v1/instances/{id}/client/action/send-message`
- Auth: HTTP bearer

Send a text message to a chat. The chatId format varies depending on the chat type:
- Individual chat: {phone_number}@c.us (e.g. 50664083362@c.us)
- Group chat: {group_id}@g.us (e.g. 123456789-123456789@g.us)
- Channel/Newsletter: {channel_id}@newsletter (e.g. 123456789@newsletter)

## Path parameters

- `id` integer, required

## Request body

- object
  - `chatId` string, required: Chat ID <countrycode_short><usernumber>@c.us or @g.us for groups
  - `message` string, required: Text message to send. Can include @123456789 for group chats.
  - `mentions` string[]: Optional array of contact IDs to mention. Only works in group chats. Make sure to include @123456789 in the message text.
  - `replyToMessageId` string: Optional message ID to reply to. Format: {fromMe}_{chatId}_{messageId}
  - `previewLink` boolean: Whether to show link previews in the message. Defaults to true.
  - `firedandforget` boolean: Set to true to process the request asynchronously. Returns a reference UUID for polling via GET /instances/{id}/request/{reference}. Alias: faf

## Response `200`

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

- object
  - `status` 'success' | 'error': Whether the request reached the instance. `success` here does **not** mean the action was carried out — that is reported by `data.status`, which is the authoritative one. A malformed input arrives as `status: success` with `data.status: error`.
  - `data` union: The action's outcome. `status: success` carries the payload; `status: error` is an `actionError`.
    - object
      - `status` 'success', required: Whether the instance carried the action out — the authoritative field. In this branch it is always `success`; when the instance refused the action the whole `data` object is an `actionError` with `status: error`, `message` and `explanation`.
      - `instanceId` union
        - integer
        - string
      - `data` object
        - `_data` object
          - `id` object
            - `fromMe` boolean
            - `remote` string
            - `id` string
            - `_serialized` string
          - `body` string
          - `type` string
          - `t` integer
          - `from` object
          - `to` object
          - `ack` integer
    - ActionError: Shape of `data` when the instance refused the action. HTTP status is still 200 and the outer `status` is still `success`.
      - `status` 'error', required
      - `message` string
      - `explanation` string
      - `instanceId` union
        - integer
        - string

## Other 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
- `422`: Validation error — invalid or missing request parameters, or the send was refused before it was attempted. A send is refused when the recipient's number is not registered (override with `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.
- `429`: Refused by the instance's send protection. Nothing was sent; retry after the given number of seconds. Integrations that already handle 429 need no change.

---

[API](https://skmtc.dev/waapi/apis/waapi-api-2.md) · [All operations](https://skmtc.dev/waapi/apis/waapi-api-2/llms.txt) · [OpenAPI document](https://skmtc.dev/waapi/apis/waapi-api-2/revisions/490302f75576?raw)
