Skip to main content
POST
Ban Chat User
Stop a user from chatting in a stream until they are unbanned. Their messages in that chat are removed. They can still watch.

Behavior

  • Only the streamer, their moderators and staff can ban people; anyone else gets 403 with type forbidden.
  • Banning the streamer gives 403 with type forbidden, and so does banning a moderator unless you are the streamer or staff. Banning yourself is 400.
  • Banning someone who is timed out replaces the timeout. Banning someone again refreshes their banned_at.
  • While banned, sending a message returns 403 with type banned.
  • The streamer can list everyone banned with List Banned Chat Users.

Example

Authorizations

api-key
string
header
required

Your API key from an app on snipp.gg/settings/apps

Path Parameters

id
string
required

User ID, or @me for your own account.

user_id
string
required

The user to ban.

Response

Banned.

user_id
string
required
banned
enum<boolean>
required
Available options:
true