Skip to main content
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

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

id
string
required
Pattern: ^[a-zA-Z0-9]{1,13}$

Body

application/json
user_id
string
required

The user to mute.

Pattern: ^[1-9][0-9]{0,18}$
end_at_ms
string

The Unix timestamp in milliseconds when the mute expires. Omit this field to mute indefinitely.

Pattern: ^[1-9][0-9]{0,18}$
message_id
string

A chat message to remove while muting the user.

Pattern: ^[1-9][0-9]{0,18}$

Response

The request has succeeded.

data
object
errors
object[]