POST /users/me/muted_users/{muted_user_id}
Mute a user from the perspective of the requesting user. Messages sent by muted users will be automatically marked as read and hidden for the user who muted them.
Muted users should be implemented by clients as follows:
- The server will immediately mark all messages sent by the muted user as read. This will automatically clear any existing mobile push notifications related to the muted user.
- The server will mark any new messages sent by the muted user as read for the requesting user's account, which prevents all email and mobile push notifications.
- Clients should exclude muted users from presence lists or other UI for viewing or composing one-on-one direct messages. One-on-one direct messages sent by muted users should be hidden everywhere in the Zulip UI.
- Channel messages and group direct messages sent by the muted user should avoid displaying the content and name/avatar, but should display that N messages by a muted user were hidden (so that it is possible to interpret the messages by other users who are talking with the muted user).
- Group direct message conversations including the muted user should display muted users as "Muted user", rather than showing their name, in lists of such conversations, along with using a blank grey avatar where avatars are displayed.
- Administrative/settings UI elements for showing "All users that exist on this channel or realm", e.g. for organization administration or showing channel subscribers, should display the user's name as normal.
Changes: New in Zulip 4.0 (feature level 48).
Servers
- https://{subdomain}.zulipchat.com/api/v1
- {server}/api/v1
- https://chat.zulip.org/api/v1
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
muted_user_id |
Integer | Yes |
The ID of the user to mute/unmute. Changes: Before Zulip 8.0 (feature level 188), bot users could not be muted/unmuted, and specifying a bot user's ID returned an error response. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.