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

# Bloquear/desbloquear contato

> Adiciona ou remove um contato da lista de bloqueados

**Auth:** `TokenAccount` ou `TokenInstance` • **Rate-limit:** `Global` (100/min) • **Idempotente:** sim

Bloqueia ou desbloqueia um contato. A resposta inclui `blocked_count`, total de contatos bloqueados na conta após a operação.

## Exemplos

### Bloquear

Adiciona o contato à lista de bloqueados (`block: true`), interrompendo o envio e recebimento de mensagens nas duas direções. O histórico anterior é preservado.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST "https://ryzeapi.cloud/api/chat/block/$Instance_Name" \
    -H "token: $Token_Instance" \
    -H "Content-Type: application/json" \
    -d '{"number": "5511999999999", "block": true}'
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/chat/block/${process.env.Instance_Name}`, {
    method: "POST",
    headers: {
      "token":        process.env.Token_Instance,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({ number: "5511999999999", block: true })
  });
  ```

  ```python Python theme={null}
  import os, requests

  requests.post(
      f"https://ryzeapi.cloud/api/chat/block/{os.environ['Instance_Name']}",
      headers={
          "token":        os.environ["Token_Instance"],
          "Content-Type": "application/json"
      },
      json={"number": "5511999999999", "block": True}
  )
  ```

  ```go Go theme={null}
  package main

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

  func main() {
      body := strings.NewReader(`{"number": "5511999999999", "block": true}`)
      req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/chat/block/"+os.Getenv("Instance_Name"), body)
      req.Header.Set("token", os.Getenv("Token_Instance"))
      req.Header.Set("Content-Type", "application/json")
      http.DefaultClient.Do(req)
  }
  ```
</CodeGroup>

### Desbloquear

Remove o contato da lista de bloqueados (`block: false`), liberando o tráfego de mensagens nas duas direções. A operação sincroniza automaticamente com o app do celular.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST "https://ryzeapi.cloud/api/chat/block/$Instance_Name" \
    -H "token: $Token_Instance" \
    -H "Content-Type: application/json" \
    -d '{"number": "5511999999999", "block": false}'
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/chat/block/${process.env.Instance_Name}`, {
    method: "POST",
    headers: {
      "token":        process.env.Token_Instance,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({ number: "5511999999999", block: false })
  });
  ```

  ```python Python theme={null}
  import os, requests

  requests.post(
      f"https://ryzeapi.cloud/api/chat/block/{os.environ['Instance_Name']}",
      headers={
          "token":        os.environ["Token_Instance"],
          "Content-Type": "application/json"
      },
      json={"number": "5511999999999", "block": False}
  )
  ```

  ```go Go theme={null}
  package main

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

  func main() {
      body := strings.NewReader(`{"number": "5511999999999", "block": false}`)
      req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/chat/block/"+os.Getenv("Instance_Name"), body)
      req.Header.Set("token", os.Getenv("Token_Instance"))
      req.Header.Set("Content-Type", "application/json")
      http.DefaultClient.Do(req)
  }
  ```
</CodeGroup>

## Resposta de sucesso

```json 200 OK theme={null}
{
  "success": true,
  "message": "Contact blocked successfully",
  "contact_jid": "5511999999999@s.whatsapp.net",
  "blocked_count": 7,
  "blocked": true
}
```

| Campo           | Tipo    | Descrição                                              |
| --------------- | ------- | ------------------------------------------------------ |
| `contact_jid`   | string  | JID do contato afetado.                                |
| `blocked`       | boolean | Estado final (`true` bloqueado, `false` liberado).     |
| `blocked_count` | int     | Total de contatos bloqueados na conta após a operação. |

## Path parameters

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

## Headers

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

## Request body

<ParamField body="number" type="string" required>
  Número ou JID do contato. Apenas contatos individuais, não funciona com grupos.
</ParamField>

<ParamField body="block" type="boolean" required>
  `true` bloqueia, `false` desbloqueia.
</ParamField>

## Notas

<Note>
  * Bloquear interrompe o envio/recebimento de mensagens nas duas direções; o histórico anterior permanece.
  * Sincroniza com o app do celular automaticamente.
  * Não há evento de webhook específico para block/unblock no modelo atual.
</Note>

## Respostas de erro

| HTTP | `error.message`                         | Quando            |
| ---- | --------------------------------------- | ----------------- |
| 400  | `Invalid request body`                  | JSON malformado.  |
| 400  | `Number is required`                    | Campo ausente.    |
| 401  | `Invalid token`                         | ,                 |
| 404  | `Instance not found`                    | ,                 |
| 503  | `Instance is not connected to WhatsApp` | Sem sessão ativa. |