Stream Chat icon

Stream Chat

Server-side Stream Chat operations

Moderation → Mute User

AI-generated

Summary

Mute a user globally in the Stream Chat platform for a specified duration with an optional reason.

Inputs

  • Target User ID (required) — The unique identifier of the user to be muted.
  • Reason — The reason for muting the user.
  • Timeout (Minutes) — Duration in minutes for which the user will be muted; defaults to 60 minutes.

Output shape

A single JSON object representing the result of the mute operation, including success status and any related metadata.

The mute duration can be set to a high value (e.g., 525600 for permanent mute). This operation applies a global mute; no channel-specific muting options are provided here. The response depends on Stream Chat API's return but generally confirms the mute action.

Discussion