Bloquear/desbloquear contato

POST

api

chat

block

:instance

Bloquear/desbloquear contato

curl --request POST \
  --url https://api.example.com/api/chat/block/:instance \
  --header 'Content-Type: application/json' \
  --header 'token: <token>' \
  --data '
{
  "number": "<string>",
  "block": true
}
'

const options = {
  method: 'POST',
  headers: {token: '<token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({number: '<string>', block: true})
};

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

import requests

url = "https://api.example.com/api/chat/block/:instance"

payload = {
    "number": "<string>",
    "block": True
}
headers = {
    "token": "<token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

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.

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}'

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 })
});

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}
)

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)
}

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.

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}'

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 })
});

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}
)

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)
}

Resposta de sucesso

200 OK

{
  "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

string

obrigatório

Nome da instância.

Headers

string

obrigatório

TokenAccount ou TokenInstance.

Request body

string

obrigatório

Número ou JID do contato. Apenas contatos individuais, não funciona com grupos.

boolean

obrigatório

true bloqueia, false desbloqueia.

Notas

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.

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.

Introdução

Instância

Eventos

Mensagens

Chamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidade

Bloquear/desbloquear contato

Exemplos

Bloquear

Desbloquear

Resposta de sucesso

Path parameters

Headers

Request body

Notas

Respostas de erro

​Exemplos

​Bloquear

​Desbloquear

​Resposta de sucesso

​Path parameters

​Headers

​Request body

​Notas

​Respostas de erro

Exemplos

Bloquear

Desbloquear

Resposta de sucesso

Path parameters

Headers

Request body

Notas

Respostas de erro