Consultar detalhes de newsletter

Amb. de Produção

https://api.way-api.io

GET

/instances/{instanceId}/newsletters/{newsletterId}

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

Retorna os detalhes de uma newsletter em que a conta conectada está inscrita.

Observações:

newsletterId deve ser um JID explícito terminado em @newsletter

a instância precisa estar conectada

newsletters não inscritas retornam 404 RESOURCE_NOT_FOUND

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

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 - Detalhes de newsletter inscrita

{
    "statusCode": 200,
    "newsletterId": "120363420314295864@newsletter",
    "name": "WayAPI News",
    "description": "Atualizações do produto",
    "pictureUrl": null,
    "subscribersCount": 42,
    "verification": "VERIFIED",
    "viewerRole": "SUBSCRIBER",
    "muted": false,
    "state": "ACTIVE",
    "handle": "wayapi",
    "inviteLink": "https://whatsapp.com/channel/invite-code",
    "createdAt": "2024-03-09T16:00:00.000Z"
}

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

Página anterior

Listar newsletters inscritas

Próxima página

Enviar mensagem com imagem