Saltar al contenido principal
POST
/
api
/
chat
/
block
/
:instance
Bloquear/desbloquear contacto
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
}
'
Auth: TokenAccount o TokenInstance • Rate-limit: Global (100/min) • Idempotente: sí Bloquea o desbloquea un contacto. La respuesta incluye blocked_count, el total de contactos bloqueados de la cuenta tras la operación.

​
Ejemplos

​
Bloquear

Agrega el contacto a la lista de bloqueados (block: true), deteniendo el envío y la recepción de mensajes en ambas direcciones. El historial previo se preserva. 
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}'

​
Desbloquear

Quita el contacto de la lista de bloqueados (block: false), reanudando el tráfico de mensajes en ambas direcciones. La operación se sincroniza automáticamente con la app del teléfono. 
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}'

​
Respuesta exitosa

200 OK
{
  "success": true,
  "message": "Contact blocked successfully",
  "contact_jid": "5511999999999@s.whatsapp.net",
  "blocked_count": 7,
  "blocked": true
}
CampoTipoDescripción
contact_jidstringJID del contacto afectado.
blockedbooleanEstado final (true bloqueado, false desbloqueado).
blocked_countintTotal de contactos bloqueados en la cuenta tras la operación.

​
Parámetros de ruta

​
instance
string
requerido
Nombre de la instancia.

​
Cabeceras

​
token
string
requerido
TokenAccount o TokenInstance.

​
Cuerpo de la solicitud

​
number
string
requerido
Número de teléfono o JID del contacto. Solo contactos individuales, no funciona con grupos.
​
block
boolean
requerido
true bloquea, false desbloquea.

​
Notas

  • Bloquear detiene el envío/recepción de mensajes en ambas direcciones; el historial previo permanece.
  • Sincroniza con la app del teléfono automáticamente.
  • No existe un evento de webhook específico para bloquear/desbloquear en el modelo actual.

​
Respuestas de error

HTTPerror.messageCuándo
400Invalid request bodyJSON malformado.
400Number is requiredCampo faltante.
401Invalid token,
404Instance not found,
503Instance is not connected to WhatsAppSin sesión activa.