Block/unblock contact

POST

api

chat

block

:instance

Block/unblock contact

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 or TokenInstance • Rate-limit: Global (100/min) • Idempotent: yes Blocks or unblocks a contact. The response includes blocked_count, the total number of blocked contacts on the account after the operation.

Examples

Block

Adds the contact to the blocked list (block: true), stopping message sending and receiving in both directions. Previous history is preserved.

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

Unblock

Removes the contact from the blocked list (block: false), unblocking message traffic in both directions. The operation syncs automatically with the phone’s app.

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

Success response

200 OK

{
  "success": true,
  "message": "Contact blocked successfully",
  "contact_jid": "5511999999999@s.whatsapp.net",
  "blocked_count": 7,
  "blocked": true
}

Field	Type	Description
`contact_jid`	string	JID of the affected contact.
`blocked`	boolean	Final state (`true` blocked, `false` unblocked).
`blocked_count`	int	Total number of blocked contacts on the account after the operation.

Path parameters

string

required

Instance name.

Headers

string

required

TokenAccount or TokenInstance.

Request body

string

required

Phone number or JID of the contact. Individual contacts only, does not work with groups.

boolean

required

true blocks, false unblocks.

Notes

Blocking stops sending/receiving messages in both directions; previous history remains.
Syncs with the phone’s app automatically.
There is no specific webhook event for block/unblock in the current model.

Error responses

HTTP	`error.message`	When
400	`Invalid request body`	Malformed JSON.
400	`Number is required`	Missing field.
401	`Invalid token`	,
404	`Instance not found`	,
503	`Instance is not connected to WhatsApp`	No active session.

Introduction

Instance

Events

Messages

Calls

Groups

Communities

Newsletter

Profile

Chat

Chatwoot

Typebot

Observability

Block/unblock contact

Examples

Block

Unblock

Success response

Path parameters

Headers

Request body

Notes

Error responses

​Examples

​Block

​Unblock

​Success response

​Path parameters

​Headers

​Request body

​Notes

​Error responses

Examples

Block

Unblock

Success response

Path parameters

Headers

Request body

Notes

Error responses