GEgetstream
product:chat

Mute user

Changed on

Mutes one or several users

Sends events:

  • user.muted
  • user.unmuted
post/moderation/mute

Request

  • Base URL
    https://chat.stream-io-api.com
  • URL
    https://chat.stream-io-api.com/moderation/mute
  • Auth
    • API key in header Authorization and API key in query parameter api_key and API key in header Stream-Auth-Type
    • or API key in query parameter api_key and API key in header Stream-Auth-Type

Request body

target_idsstring[]

User IDs to mute (if multiple users)

timeoutinteger required

Duration of mute in minutes

user_idstring

Response

Successful response

durationstring required
non_existing_usersstring[]

Changes

  • 00df5052235bRevision changes
    • info

      added the optional property ///// to the response with the status

  • 8acf79c23a74Revision changes
    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status