Xx
Broadcasts

Mute or Time Out a User in Chat

Changed on

Prevents a user from posting messages in all of a broadcaster's chats. Without broadcast_id, the user is muted in the authenticated user's own chats. Moderators pass broadcast_id to mute the user in that broadcast host's chats. When end_at_ms is provided, the mute expires at that time.

post/2/broadcasts/chat/mutes

Request

  • Base URL
    https://api.x.com
  • URL
    https://api.x.com/2/broadcasts/chat/mutes
  • Auth
    • OAuth 2
      Authorization code: https://api.x.com/2/oauth2/authorize
      Token URL: https://api.x.com/2/oauth2/token scopes: broadcast.read, broadcast.write
    • or HTTP oauth

Request body

broadcast_idstring

A broadcast whose host's chats the user is muted in. Required with message_id.

end_at_msstring

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

message_idstring

A chat message in broadcast_id to remove while muting the user.

user_idstring required

The user to mute.

Response

The request has succeeded.

Changes