Moderation endpoints let clients list, add, and remove channel moderators, ban users, remove bans, and temporarily mute users in a channel. Every https://api.blaze.stream/v1 request on this page must include client-id: YOUR_CLIENT_ID.
Returns channels where the target user has the moderator role. User Access Token requires users.read and userId must match the token user UUID. App Access Token is accepted when the userId user granted users.read to the application.
Required header for every https://api.blaze.stream/v1 request: client-id: YOUR_CLIENT_ID.
Authorizations
Use when listing channels moderated by the signed-in user. userId must match the token user UUID.
Scopes
users.read
Query parameters
userIdstring · UUIDrequired
Target user UUID whose moderated channels should be listed.
Returns moderators for the target channel. This endpoint accepts both User Access Token and App Access Token with the same required channelId query parameter.
Required header for every https://api.blaze.stream/v1 request: client-id: YOUR_CLIENT_ID.
Authorizations
Use either User Access Token or App Access Token. Both token types use the same required channelId query parameter.
Adds userId as a moderator for channelId. Only User Access Token is accepted. channelId and userId must both be UUID values, and the token user's UUID must match the body channelId.
Required header for every https://api.blaze.stream/v1 request: client-id: YOUR_CLIENT_ID.
Authorizations
Only User Access Token is accepted. The token user's UUID must match channelId in the request body.
Scopes
channel.moderate
The token user must be the channel owner: token user UUID and body channelId must be the same UUID.
Request body
channelIdstring · UUIDrequired
Target channel UUID where the moderation action should run.
userIdstring · UUIDrequired
User UUID to add to or remove from the channel moderator list.
Removes userId from the moderator list for channelId. Only User Access Token is accepted. channelId and userId must both be UUID values, and the token user's UUID must match the body channelId.
Required header for every https://api.blaze.stream/v1 request: client-id: YOUR_CLIENT_ID.
Authorizations
Only User Access Token is accepted. The token user's UUID must match channelId in the request body.
Scopes
channel.moderate
The token user must be the channel owner: token user UUID and body channelId must be the same UUID.
Request body
channelIdstring · UUIDrequired
Target channel UUID where the moderation action should run.
userIdstring · UUIDrequired
User UUID to add to or remove from the channel moderator list.
Bans a user from the target channel. Send either banUserId or banUsername to identify the user. Blaze prevents banning the channel itself, marks the user as banned, deletes that user's existing channel messages, and emits the related moderation updates.
Required header for every https://api.blaze.stream/v1 request: client-id: YOUR_CLIENT_ID.
Authorizations
Use when the signed-in token user is acting as the moderator. The token user must own the channel or have the channel moderator role.
Scopes
channel.moderate
The OAuth scope is required in addition to channel ownership or channel moderator permission.
Request body
channelIdstring · UUIDrequired
Target channel UUID where the moderation action should run.
banUserIdstringoptional
Target user UUID. Provide either banUserId or banUsername.
banUsernamestringoptional
Target username. Provide either banUsername or banUserId.
Deletes the ban for a user who is currently banned in the target channel. Send either banUserId or banUsername to identify the user. If the user is not currently banned, Blaze returns 404.
Required header for every https://api.blaze.stream/v1 request: client-id: YOUR_CLIENT_ID.
Authorizations
Use when the signed-in token user is acting as the moderator. The token user must own the channel or have the channel moderator role.
Scopes
channel.moderate
The OAuth scope is required in addition to channel ownership or channel moderator permission.
Request body
channelIdstring · UUIDrequired
Target channel UUID where the moderation action should run.
banUserIdstringoptional
Target user UUID. Provide either banUserId or banUsername.
banUsernamestringoptional
Target username. Provide either banUsername or banUserId.
Mutes the target user in the channel for 10 minutes and deletes that user's existing channel messages. If the user already has an active mute, Blaze returns 409 with the existing mute expiration.
Required header for every https://api.blaze.stream/v1 request: client-id: YOUR_CLIENT_ID.
Authorizations
Use when the signed-in token user is acting as the moderator. The token user must own the channel or have the channel moderator role.
Scopes
channel.moderate
The OAuth scope is required in addition to channel ownership or channel moderator permission.
Request body
channelIdstring · UUIDrequired
Target channel UUID where the moderation action should run.