1. Instâncias
  • Raiz
    • Webhooks
      • Criar ou atualizar webhook
      • Desativar webhook
    • Instâncias
      • Listar instâncias
        GET
      • Criar instância
        POST
      • Atualizar nome da instância
        PATCH
      • Remover instância
        DELETE
      • Listar chats da instância
        GET
      • Conectar instância
        POST
      • Desconectar instância
        POST
      • Consultar detalhes de grupo
        GET
      • Listar newsletters inscritas
        GET
      • Consultar detalhes de newsletter
        GET
      • Consultar último QR code da instância
        GET
      • Consultar status da instância
        GET
    • Mensagens
      • Enviar mensagem com imagem
      • Enviar mensagem com prévia de link
      • Listar mensagens pendentes
      • Cancelar mensagens pendentes
      • Enviar mensagem de texto
  • Esquemas
    • OrderedInboundWebhookPayloadBase
  1. Instâncias

Listar newsletters inscritas

Amb. de Produção
https://api.way-api.io
Amb. de Produção
https://api.way-api.io
GET
/instances/{instanceId}/newsletters
Última modificação:2026-09-17 22:00:23
Lista as newsletters em que a conta do WhatsApp está inscrita.
A instância precisa estar conectada. Use newsletterId como targetId para enviar mensagens.
Mudanças feitas no WhatsApp podem levar até 15 minutos para aparecer nesta lista.

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 Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.way-api.io/instances//newsletters' \
--header 'x-api-key: <api-key>'
Response 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-09-17 22:00:23
Página anterior
Consultar detalhes de grupo
Próxima página
Consultar detalhes de newsletter
Built with