Skip to main content
POST
Time Out Chat User
Stop a user from chatting in a stream for a while. Their messages in that chat are removed.

Behavior

  • Only the streamer, their moderators and staff can time people out; anyone else gets 403 with type forbidden.
  • seconds is 60, 600, 3600 or 86400.
  • Timing out the streamer gives 403 with type forbidden, and so does timing out a moderator unless you are the streamer or staff. Timing yourself out is 400.
  • Timing out someone again replaces their current timeout, and timing out someone who is banned replaces the ban.
  • Remove the timeout to let them chat again early, or ban them to stop them for good.
  • While timed out, sending a message returns 403 with type timed_out.

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 time out.

Body

application/json
seconds
enum<integer>
required
Available options:
60,
600,
3600,
86400

Response

Timed out.

user_id
string
required
expires_at
string<date-time>
required