Mute chat

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

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

fetch('https://api.example.com/api/chat/mute/: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/mute/:instance"

payload = {
    "number": "<string>",
    "mute": True,
    "duration": "<string>"
}
headers = {"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

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

await fetch(`https://ryzeapi.cloud/api/chat/mute/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    number:   "5511999999999",
    mute:     true,
    duration: "8h"
  })
});

import os, requests

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

package main

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

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

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

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

import os, requests

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

package main

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

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

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

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

import os, requests

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

package main

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

func main() {
    body := strings.NewReader(`{
        "number": "5511999999999",
        "mute":   false
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/chat/mute/"+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

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

string

required

Instance name.

Headers

Name	Required	Example	Description
`Content-Type`	yes	`application/json`	,
`token`	yes (or `Authorization`)	`a1b2c3d4-...`	TokenAccount or TokenInstance.

Request body

string

required

Phone number, private JID (...@s.whatsapp.net or ...@lid), group JID (...@g.us), or newsletter.

boolean

required

true mutes, false unmutes.

string

Mute duration. Accepts the formats in the table below. Ignored when mute=false.

Accepted values for `duration`

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

Error responses

HTTP	`error.message`	When it happens
400	`Instance name is required`	,
400	`Invalid request body: <...>`	Malformed JSON.
400	`Number is required`	,
400	`Invalid duration: <...>`	Unrecognized format.
401	`Invalid token`	,
404	`Instance not found`	,
503	`Instance 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

Introduction

Instance

Events

Messages

Calls

Groups

Communities

Newsletter

Profile

Chat

Chatwoot

Typebot

Observability

Description

Examples

Mute for 8h

Mute permanently

Unmute

Success response

Path parameters

Headers

Request body

Accepted values for `duration`

Error responses

Archive chat

Block contact

​Description

​Examples

​Mute for 8h

​Mute permanently

​Unmute

​Success response

​Path parameters

​Headers

​Request body

​Accepted values for duration

​Error responses

​Related

Archive chat

Block contact

Description

Examples

Mute for 8h

Mute permanently

Unmute

Success response

Path parameters

Headers

Request body

Accepted values for `duration`

Error responses

Related