Unmute a user

DELETE https://str0m.zulipchat.com/api/v1/users/me/muted_users/{muted_user_id}

Unmute a user from the perspective of the requesting user.

Changes: New in Zulip 4.0 (feature level 48).

Usage examples

#!/usr/bin/env python3

import zulip

# Pass the path to your zuliprc file here.
client = zulip.Client(config_file="~/zuliprc")

# Unmute a user, given the user's ID.
result = client.call_endpoint(url=f"/users/me/muted_users/{muted_user_id}", method="DELETE")
print(result)

curl -sSX DELETE https://str0m.zulipchat.com/api/v1/users/me/muted_users/10 \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY

Parameters

Response

Example response(s)

Changes: As of Zulip 7.0 (feature level 167), if any parameters sent in the request are not supported by this endpoint, a successful JSON response will include an ignored_parameters_unsupported array.

A typical successful JSON response may look like:

{
    "msg": "",
    "result": "success"
}

An example JSON response for when the user is nonexistent or inaccessible:

{
    "code": "BAD_REQUEST",
    "msg": "No such user",
    "result": "error"
}

An example JSON response for when the user is not previously muted:

{
    "code": "BAD_REQUEST",
    "msg": "User is not muted",
    "result": "error"
}