> ## 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.

# API de Canais do WhatsApp (Newsletters)

> Liste os canais do WhatsApp (newsletters) vinculados ao número conectado.

Os canais do WhatsApp usam identificadores terminados em `@newsletter`. O Pilot Status oferece **listagem opcional** desses canais (id e nome, quando conhecido) para a **mesma instância do WhatsApp** vinculada à sua API key, assim como `POST /v1/messages/send`.

<Warning>
  Canais/newsletters **não são suportados para números da Meta Cloud API**.
</Warning>

## API Pública

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

* **200** com `{ "newsletters": [ { "id": "…@newsletter", "name": "…" } ] }`.
* Mesmas regras de **instância** e sessão **conectada** (`OPEN`) que `GET /v1/groups`; se não estiver conectada, **409** com `WHATSAPP_INSTANCE_NOT_CONNECTED`.
* Se a key não tiver uma instância vinculada, **200** com um array `newsletters` vazio.
* Quando a **listagem de canais** não está habilitada para o seu workspace, a API ainda retorna **200** com um array **vazio** (não é um erro).

## Exemplo

<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 (sessão)

Em **Números**, quando o número estiver conectado (**OPEN**), use **Listar newsletters do WhatsApp** para os mesmos dados.

## Webhooks e envio

* O tráfego de entrada de canais é entregue como **`message.newsletter`** (veja a documentação de webhooks).
* `POST /v1/messages/send` e a listagem de canais são fluxos independentes; veja a documentação de envio de mensagens para as regras de destino.

## n8n

O node oficial pode carregar opções de `GET /v1/newsletters` no controle opcional **Additional fields** quando uma lista é retornada.