Live Chat
Mute a Chat User
POST /2/broadcasts/:id/chat/mutes prevents a user from posting further messages in a running broadcast chat, optionally for a bounded time out and with a message removed in the same call.
POST
Mute or time out a user in a broadcast chat
Prevents a user from posting further messages in a running broadcast chat.
:id is the alphanumeric broadcast_id.
The authenticated user must be the broadcast owner or a chat moderator for the broadcast owner. See List Broadcast Moderators for how moderators are managed.
Pass an optional end_at_ms in the request body to time the mute out at a specific Unix timestamp in milliseconds. Omit end_at_ms to mute the user indefinitely.
Pass an optional message_id in the request body to remove a specific chat message at the same time. This is useful when muting is in response to a particular message.
To reverse this, use Unmute a Chat User. To remove an individual message without muting its author, use Delete a Chat Message.
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Pattern:
^[a-zA-Z0-9]{1,13}$Body
application/json