Pular para o conteúdo principal
DELETE
/
api
/
newsletter
/
leave
/
:instance
Sair do canal
curl --request DELETE \
  --url https://api.example.com/api/newsletter/leave/:instance \
  --header 'token: <token>'

Documentation Index

Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt

Use this file to discover all available pages before exploring further.

Auth: TokenAccount ou TokenInstance • Rate-limit: Global (100/min) • Idempotente: parcial (sair de um canal não seguido pode retornar not found)

​
Descrição

Cancela a inscrição (unfollow). Mensagens futuras param de chegar e o canal some de GET /list. O identifier vai como query string (e não no body), por se tratar de DELETE.

​
Exemplos

​
Por JID

Cancela a inscrição passando o JID canônico do canal via query string. Mensagens futuras param de chegar e o canal some de GET /list. 
curl -X DELETE "https://ryzeapi.cloud/api/newsletter/leave/$Instance_Name?identifier=120363422585881117@newsletter" \
  -H "token: $Token_Instance"
Cancela a inscrição passando o link de convite completo. O servidor extrai o código, resolve o JID e executa o unfollow. 
curl -X DELETE -G "https://ryzeapi.cloud/api/newsletter/leave/$Instance_Name" \
  --data-urlencode "identifier=https://whatsapp.com/channel/120363422585881117" \
  -H "token: $Token_Instance"

​
Por código

Cancela a inscrição passando apenas o código de convite. Atalho equivalente ao link, sem o prefixo do domínio. 
curl -X DELETE "https://ryzeapi.cloud/api/newsletter/leave/$Instance_Name?identifier=120363422585881117" \
  -H "token: $Token_Instance"

​
Resposta de sucesso

A resposta traz o JID canônico do canal em channelJid (resolvido a partir do identifier passado na query, mesmo se foi link ou código). Após esse retorno, o canal é removido de /list e mensagens futuras param de chegar.
200 OK
{
  "success": true,
  "message": "Successfully left newsletter",
  "channelJid": "120363422585881117@newsletter"
}

​
Parâmetros de rota

​
instance
string
obrigatório
Nome da instância.

​
Headers

​
token
string
obrigatório
TokenAccount ou TokenInstance.

​
Query

​
identifier
string
obrigatório
JID @newsletter, link completo ou código de convite.

​
Notas

  • Se você é o dono / admin do canal, leave apenas te desinscreve, o canal continua existindo. Para deletar o canal, use a interface oficial do WhatsApp.
  • DELETE sem body é a convenção, body JSON é ignorado.
  • Sem evento dedicado de “unfollowed” no webhook; mensagens do canal simplesmente param de chegar.

​
Erros

HTTPMensagem
400The 'identifier' query parameter is required (JID @newsletter or invite link/code)
400Invalid newsletter identifier (use JID @newsletter or invite link/code)
500failed to leave newsletter: <reason>
501WhatsApp client does not support UnfollowNewsletter
Envelope: 
{
  "success": false,
  "error": { "message": "Invalid newsletter identifier (use JID @newsletter or invite link/code)" }
}

​
Próximo

Listar canais

Confirmar que o canal foi removido.

Entrar de novo

Reinscrever-se em outro canal.