Sair do canal

DELETE

api

newsletter

leave

:instance

Sair do canal

curl --request DELETE \
  --url https://api.example.com/api/newsletter/leave/:instance \
  --header 'token: <token>'

const options = {method: 'DELETE', headers: {token: '<token>'}};

fetch('https://api.example.com/api/newsletter/leave/:instance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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"

await fetch(`https://ryzeapi.cloud/api/newsletter/leave/${process.env.Instance_Name}?identifier=120363422585881117@newsletter`, {
  method: "DELETE",
  headers: {
    "token": process.env.Token_Instance
  }
});

import os, requests

requests.delete(
    f"https://ryzeapi.cloud/api/newsletter/leave/{os.environ['Instance_Name']}",
    params={"identifier": "120363422585881117@newsletter"},
    headers={
        "token": os.environ["Token_Instance"]
    }
)

package main

import (
    "net/http"
    "os"
)

func main() {
    req, _ := http.NewRequest("DELETE", "https://ryzeapi.cloud/api/newsletter/leave/"+os.Getenv("Instance_Name")+"?identifier=120363422585881117@newsletter", nil)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    http.DefaultClient.Do(req)
}

Por link

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"

const params = new URLSearchParams({ identifier: "https://whatsapp.com/channel/120363422585881117" });
await fetch(`https://ryzeapi.cloud/api/newsletter/leave/${process.env.Instance_Name}?${params}`, {
  method: "DELETE",
  headers: {
    "token": process.env.Token_Instance
  }
});

import os, requests

requests.delete(
    f"https://ryzeapi.cloud/api/newsletter/leave/{os.environ['Instance_Name']}",
    params={"identifier": "https://whatsapp.com/channel/120363422585881117"},
    headers={
        "token": os.environ["Token_Instance"]
    }
)

package main

import (
    "net/http"
    "net/url"
    "os"
)

func main() {
    q := url.Values{}
    q.Set("identifier", "https://whatsapp.com/channel/120363422585881117")
    req, _ := http.NewRequest("DELETE", "https://ryzeapi.cloud/api/newsletter/leave/"+os.Getenv("Instance_Name")+"?"+q.Encode(), nil)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    http.DefaultClient.Do(req)
}

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"

await fetch(`https://ryzeapi.cloud/api/newsletter/leave/${process.env.Instance_Name}?identifier=120363422585881117`, {
  method: "DELETE",
  headers: {
    "token": process.env.Token_Instance
  }
});

import os, requests

requests.delete(
    f"https://ryzeapi.cloud/api/newsletter/leave/{os.environ['Instance_Name']}",
    params={"identifier": "120363422585881117"},
    headers={
        "token": os.environ["Token_Instance"]
    }
)

package main

import (
    "net/http"
    "os"
)

func main() {
    req, _ := http.NewRequest("DELETE", "https://ryzeapi.cloud/api/newsletter/leave/"+os.Getenv("Instance_Name")+"?identifier=120363422585881117", nil)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    http.DefaultClient.Do(req)
}

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

string

obrigatório

Nome da instância.

Headers

string

obrigatório

TokenAccount ou TokenInstance.

Query

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

HTTP	Mensagem
400	`The 'identifier' query parameter is required (JID @newsletter or invite link/code)`
400	`Invalid newsletter identifier (use JID @newsletter or invite link/code)`
500	`failed to leave newsletter: <reason>`
501	`WhatsApp client does not support UnfollowNewsletter`

Envelope:

{
  "success": false,
  "error": { "message": "Invalid newsletter identifier (use JID @newsletter or invite link/code)" }
}

Listar canais

Confirmar que o canal foi removido.

Entrar de novo

Reinscrever-se em outro canal.

Introdução

Instância

Eventos

Mensagens

Chamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidade

Descrição

Exemplos

Por JID

Por link

Por código

Resposta de sucesso

Parâmetros de rota

Headers

Query

Notas

Erros

Próximo

Listar canais

Entrar de novo

​Descrição

​Exemplos

​Por JID

​Por link

​Por código

​Resposta de sucesso

​Parâmetros de rota

​Headers

​Query

​Notas

​Erros

​Próximo

Listar canais

Entrar de novo

Descrição

Exemplos

Por JID

Por link

Por código

Resposta de sucesso

Parâmetros de rota

Headers

Query

Notas

Erros

Próximo