Skip to main content
PATCH
Update Live Stream
Change your stream title, your chat settings, or replace your list of chat moderators.

Behavior

  • Send any of title, moderators, chat_enabled and chat_slow_seconds. Sending none is 400.
  • title is up to 140 characters. An empty string or null clears it, and the watch page shows a default title instead.
  • moderators is the complete list of user IDs, up to 10, and replaces the current list. Send [] to remove everyone. You cannot add yourself. A user who does not exist or is suspended gives 404, and a user who blocked you, or whom you blocked, gives 403 with type blocked.
  • Moderators can remove messages, time people out and ban people in your chat. Only you and staff can time out or ban a moderator.
  • chat_enabled: false turns the chat off: nobody, you included, can read or send messages until you turn it back on. Nothing is deleted.
  • chat_slow_seconds is 0 (off), 5, 10, 30 or 60: how long each viewer waits between messages. You, your moderators and staff are exempt.
  • Returns 404 if streaming is not set up.

Example

Authorizations

relay-key
string
header
required

Your relay key from snipp.gg/settings/relay

Body

application/json
title
string | null

Up to 140 characters. Empty or null clears it.

Maximum string length: 140
moderators
string[]

The full list of moderator user IDs. Replaces the current list.

Maximum array length: 10
chat_enabled
boolean

Turn the chat on or off. Off hides every message until it is back on.

chat_slow_seconds
enum<integer>

Seconds each viewer waits between messages. 0 turns slow mode off.

Available options:
0,
5,
10,
30,
60

Response

Success.

live_stream
object
required

Your own live stream, including the credentials to go live.