---
title: "[BETA] send community announcement"
method: POST
path: "/instances/{id}/client/action/send-community-announcement"
tags: ["community"]
---

# \[BETA\] send community announcement

`POST /instances/{id}/client/action/send-community-announcement`

## Request

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

Post an announcement to a Community. Supports text (message), URL-based media (mediaUrl), and broadcast targeting. target='general' (default) posts only to the default announcement subgroup which reaches every community member and returns the message result synchronously. target='all' broadcasts sequentially to every linked subgroup and is ALWAYS dispatched asynchronously — the response contains a `reference` you can poll via GET /instances/{id}/request/{reference} instead of the message payload. If both message and mediaUrl are provided without mediaCaption, message is used as the media caption. Note: This endpoint is currently in beta and may change without notice.

## Path parameters

- `id` integer, required

## Request body

- object
  - `communityId` string, required
  - `target` 'general' | 'all'
  - `message` string
  - `mediaUrl` string
  - `mediaCaption` string
  - `mediaName` string
  - `previewLink` boolean
  - `asSticker` boolean
  - `asVoice` boolean
  - `asDocument` boolean

## Response `200`

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

- 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: Action payload.
    - 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 or community does not exist
- `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)