> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pilotstatus.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# WhatsApp Channels (Newsletters) API

> List WhatsApp channels (newsletters) tied to the connected number.

WhatsApp channels use identifiers ending in `@newsletter`. Pilot Status offers **optional listing** of those channels (id and name when known) for the **same WhatsApp instance** tied to your API key as `POST /v1/messages/send`.

<Warning>
  Channels/newsletters are **not supported for Meta Cloud API numbers**.
</Warning>

## Public API

`GET https://pilotstatus.com.br/v1/newsletters`

* **200** with `{ "newsletters": [ { "id": "…@newsletter", "name": "…" } ] }`.
* Same **instance** and **connected** session rules (`OPEN`) as `GET /v1/groups`; if not connected, **409** with `WHATSAPP_INSTANCE_NOT_CONNECTED`.
* If the key has no linked instance, **200** with an empty `newsletters` array.
* When **channel listing** is not enabled for your workspace, the API still returns **200** with an **empty** array (not an error).

## Example

<CodeGroup>
  ```bash cURL theme={null}
  curl "https://pilotstatus.com.br/v1/newsletters" \
    -H "x-api-key: ps_your_key_here"
  ```

  ```json Response (200) theme={null}
  {
    "newsletters": [
      { "id": "120363123456789012@newsletter", "name": "Product Updates" }
    ]
  }
  ```
</CodeGroup>

## Dashboard (session)

On **Numbers**, when the number is connected (**OPEN**), use **List WhatsApp newsletters** for the same data.

## Webhooks and sending

* Inbound channel traffic is delivered as **`message.newsletter`** (see webhooks documentation).
* `POST /v1/messages/send` and channel listing are independent flows; see the send-message docs for destination rules.

## n8n

The official node may load options from `GET /v1/newsletters` in the optional **Additional fields** control when a list is returned.
