Listar newsletters inscritas

Amb. de Produção

https://api.way-api.io

GET

/instances/{instanceId}/newsletters

Última modificação:2026-07-31 03:01:30

Lista todas as newsletters em que a conta WhatsApp conectada está inscrita.

Observações:

a instância precisa estar conectada

os resultados são armazenados em cache por até 15 minutos

use newsletterId como targetId nas rotas de mensagens

Requisição

Authorization

Adicionar parâmetro em header

x-api-key

Exemplo:

x-api-key: ********************

Parâmetros de Caminho

Parâmetros Header

Respostas

🟢200OK

application/json

The request has succeeded.

Bodyapplication/json

🟠400Requisição Inválida

🟠401Não Autorizado

🟠403Proibido

🟠404Registo Não Encontrado

🟠422Erro de Parâmetro

🟠429

🔴500Erro do Servidor

🔴502Gateway Inválido

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.way-api.io/instances//newsletters' \
--header 'x-api-key: <api-key>'

Response Example

200 - Newsletters inscritas

{
    "newsletters": [
        {
            "newsletterId": "120363420314295864@newsletter",
            "name": "WayAPI News",
            "description": "Atualizações do produto",
            "pictureUrl": null,
            "subscribersCount": 42,
            "verification": "VERIFIED",
            "viewerRole": "SUBSCRIBER",
            "muted": false
        }
    ]
}

Modificado em 2026-07-31 03:01:30

Página anterior

Consultar status da instância

Próxima página

Consultar detalhes de newsletter