> ## 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.

# Sair do canal

> Cancela a inscrição da conta em um canal

**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`](/pt/api/newsletter/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`.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE "https://ryzeapi.cloud/api/newsletter/leave/$Instance_Name?identifier=120363422585881117@newsletter" \
    -H "token: $Token_Instance"
  ```

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

  ```python Python theme={null}
  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"]
      }
  )
  ```

  ```go Go theme={null}
  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)
  }
  ```
</CodeGroup>

### 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.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE -G "https://ryzeapi.cloud/api/newsletter/leave/$Instance_Name" \
    --data-urlencode "identifier=https://whatsapp.com/channel/120363422585881117" \
    -H "token: $Token_Instance"
  ```

  ```javascript JavaScript theme={null}
  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
    }
  });
  ```

  ```python Python theme={null}
  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"]
      }
  )
  ```

  ```go Go theme={null}
  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)
  }
  ```
</CodeGroup>

### Por código

Cancela a inscrição passando apenas o código de convite. Atalho equivalente ao link, sem o prefixo do domínio.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X DELETE "https://ryzeapi.cloud/api/newsletter/leave/$Instance_Name?identifier=120363422585881117" \
    -H "token: $Token_Instance"
  ```

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

  ```python Python theme={null}
  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"]
      }
  )
  ```

  ```go Go theme={null}
  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)
  }
  ```
</CodeGroup>

## 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`](/pt/api/newsletter/list) e mensagens futuras param de chegar.

```json 200 OK theme={null}
{
  "success": true,
  "message": "Successfully left newsletter",
  "channelJid": "120363422585881117@newsletter"
}
```

## Parâmetros de rota

<ParamField path="instance" type="string" required>
  Nome da instância.
</ParamField>

## Headers

<ParamField header="token" type="string" required>
  `TokenAccount` ou `TokenInstance`.
</ParamField>

## Query

<ParamField query="identifier" type="string" required>
  JID `@newsletter`, link completo ou código de convite.
</ParamField>

## Notas

<Note>
  * 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.
</Note>

## 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:

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

## Próximo

<CardGroup cols={2}>
  <Card title="Listar canais" icon="list" href="/pt/api/newsletter/list">
    Confirmar que o canal foi removido.
  </Card>

  <Card title="Entrar de novo" icon="plus" href="/pt/api/newsletter/join">
    Reinscrever-se em outro canal.
  </Card>
</CardGroup>
