Skip to main content
POST
/
api
/
chat
/
mute
/
:instance
Mute chat
curl --request POST \
  --url https://api.example.com/api/chat/mute/:instance \
  --header 'Content-Type: application/json' \
  --data '
{
  "number": "<string>",
  "mute": true,
  "duration": "<string>"
}
'

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.

Auth: TokenAccount or TokenInstance • Rate-limit: Global (100/min) • Idempotent: yes

​
Description

Mutes (mute: true) or unmutes (mute: false) a chat. The duration parameter accepts several human-readable formats to set the window.

​
Examples

​
Mute for 8h

Mutes the chat for an 8-hour window with duration: "8h". At the end of the period notifications come back automatically, no other call is needed. 
curl -X POST "https://ryzeapi.cloud/api/chat/mute/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "number":   "5511999999999",
    "mute":     true,
    "duration": "8h"
  }'

​
Mute permanently

With duration: "always" (also accepts "forever" and "permanent"), the chat stays muted indefinitely until you send another call with mute: false. 
curl -X POST "https://ryzeapi.cloud/api/chat/mute/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "number":   "5511999999999",
    "mute":     true,
    "duration": "always"
  }'

​
Unmute

With mute: false, removes any active mute on the chat and notifications resume normally. The duration field is ignored in this variant. 
curl -X POST "https://ryzeapi.cloud/api/chat/mute/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "number": "5511999999999",
    "mute":   false
  }'

​
Success response

muted indicates the final state and duration comes in seconds (28800 = 8h, 604800 = 1 week, 0 = permanent or unmuted). The message changes per operation: "Chat muted permanently", "Chat muted for 8 hours", "Chat muted for 1 week", or "Chat notifications unmuted successfully".
200 OK
{
  "success": true,
  "message": "Chat muted for 8 hours",
  "chat_jid": "5511999999999@s.whatsapp.net",
  "muted": true,
  "duration": 28800
}

​
Path parameters

​
instance
string
required
Instance name.

​
Headers

NameRequiredExampleDescription
Content-Typeyesapplication/json—
tokenyes (or Authorization)a1b2c3d4-...TokenAccount or TokenInstance.

​
Request body

​
number
string
required
Phone number, private JID (...@s.whatsapp.net or ...@lid), group JID (...@g.us), or newsletter.
​
mute
boolean
required
true mutes, false unmutes.
​
duration
string
Mute duration. Accepts the formats in the table below. Ignored when mute=false.

​
Accepted values for duration

ValueMeaning
"8h" or "8 hours"8 hours
"1w", "7d", or "1 week"1 week
"always", "forever", "permanent"No expiration
(empty)No expiration

​
Error responses

HTTPerror.messageWhen it happens
400Instance name is required—
400Invalid request body: <...>Malformed JSON.
400Number is required—
400Invalid duration: <...>Unrecognized format.
401Invalid token—
404Instance not found—
503Instance is not connected to WhatsApp—
Error 400
{
  "success": false,
  "error": { "message": "Invalid duration: 5y" }
}

Archive chat

POST /api/chat/archive/:instance

Block contact

POST /api/chat/block/:instance