Moderation
Promotes a user to moderator in the specified Twitch channel. To demote a moderator, use Remove Moderator.
If Channel is empty, SAMMI uses the default Twitch account.
| Box Name | Type | Description |
|---|---|---|
| Channel | String | The channel to promote the specified user in |
| User Name | String | The username of the person to be promoted |
channel:manage:moderators and user:read:email Twitch scopes.
Removes moderator status from a user in the specified Twitch channel.
If Channel is empty, SAMMI uses the default Twitch account.
| Box Name | Type | Description |
|---|---|---|
| Channel | String | The channel to demote the specified user in |
| User Name | String | The username of the person to be demoted |
channel:manage:moderators and user:read:email Twitch scopes.
Promotes a user to VIP in the specified Twitch channel. To remove VIP status, use Remove VIP.
If Channel is empty, SAMMI uses the default Twitch account.
| Box Name | Type | Description |
|---|---|---|
| Channel | String | The channel to promote the specified user in |
| User Name | String | The username of the person to be promoted |
channel:manage:vips and user:read:email Twitch scopes.
Removes VIP status from a user in the specified Twitch channel.
If Channel is empty, SAMMI uses the default Twitch account.
| Box Name | Type | Description |
|---|---|---|
| Channel | String | The channel to demote the specified user in |
| User Name | String | The username of the person to be demoted |
channel:manage:vips and user:read:email Twitch scopes.
Starts a raid, which sends the current viewers to the specified target channel after a 90 second countdown.
If Channel is empty, SAMMI uses the default Twitch account.
| Box Name | Type | Description |
|---|---|---|
| Channel | String | Channel to start the raid in |
| Raid Target | String | Channel to raid |
channel:manage:raids Twitch scope. The broadcaster can still cancel the raid before the countdown finishes.
Cancels an ongoing raid, as long as the countdown timer has not expired and the broadcaster has not clicked the Raid Now button.
If Channel is empty, SAMMI uses the default Twitch account.
| Box Name | Type | Description |
|---|---|---|
| Channel | String | The channel to cancel the ongoing raid in |
channel:manage:raids Twitch scope.
Bans a user from participating in the specified broadcaster’s chat room. To remove the ban, use Unban User.
If Channel is empty, SAMMI uses the default Twitch account.
| Box Name | Type | Description |
|---|---|---|
| Channel | String | The channel to ban the specified user in |
| User Name | String | The username of the person to be banned |
| Reason | String | (optional) The reason why you are banning them |
moderator:manage:banned_users and user:read:email Twitch scopes.
Removes the ban or timeout for the specified user in the selected Twitch channel.
If Channel is empty, SAMMI uses the default Twitch account.
| Box Name | Type | Description |
|---|---|---|
| Channel | String | The channel to unban/untimeout the specified user in |
| User Name | String | The username of the person to unban/untimeout |
moderator:manage:banned_users and user:read:email Twitch scopes.
Times out a user from participating in the specified broadcaster’s chat room for the specified amount of time. To remove the timeout, use Unban User.
If Channel is empty, SAMMI uses the default Twitch account.
| Box Name | Type | Description |
|---|---|---|
| Channel | String | The channel to timeout the specified user in |
| User Name | String | The username of the person to be timed out |
| Duration | Number | How long to timeout the user, in seconds. If left blank, defaults to 5 minutes (300 seconds). |
| Reason | String | (optional) The reason why you are timing them out |
moderator:manage:banned_users and user:read:email Twitch scopes.
Sets the color of your username in all chat rooms to one of the default Twitch colors.
For Turbo/Prime members who can set any color, use the button at the bottom of the section.
To get a user’s current color, use Get User Color
| Box Name | Type | Description |
|---|---|---|
| Login Name | Dropdown | The name of the channel to use for authentication in the API Header |
| Color | Dropdown | List of the standard colours that Twitch offers for all users. |
user:manage:chat_color Twitch scope.
Enables or disables Slow Mode in the specified channel. Slow Mode restricts how often users can talk in a channel to once per specified amount of time. VIPs and Moderators are not restricted.
If Channel is empty, SAMMI uses the default Twitch account.
| Box Name | Type | Description |
|---|---|---|
| Channel | String | Channel name to set Slow Mode for |
| Enabled | Dropdown | Enable/Disable |
| Time | Number | Amount of time, in seconds, that users must wait before they can chat again |
moderator:manage:chat_settings Twitch scope.
Enables or disables Follower-Only Mode in the specified channel. Follower-Only Mode restricts who can talk in a channel to only followers who have been following for the specified amount of time. VIPs and Moderators are not restricted.
If Channel is empty, SAMMI uses the default Twitch account.
| Box Name | Type | Description |
|---|---|---|
| Channel | String | Channel name to set Follower-Only Mode for |
| Enabled | Dropdown | Enable/Disable |
| Time | Dropdown | Specific amounts of time that users need to have followed for |
moderator:manage:chat_settings Twitch scope.
Enables or disables Subscriber-Only Mode in the specified channel. Subscriber-Only Mode restricts who can talk in a channel to only subscribers. VIPs and Moderators are not restricted.
If Channel is empty, SAMMI uses the default Twitch account.
| Box Name | Type | Description |
|---|---|---|
| Channel | String | Channel name to set Subscriber-Only Mode for |
| Enabled | Dropdown | Enable/Disable |
moderator:manage:chat_settings Twitch scope.
Enables or disables Emote-Only Mode in the specified channel. Emote-Only Mode restricts what can be said in chat to only emotes. VIPs and Moderators are not restricted.
If Channel is empty, SAMMI uses the default Twitch account.
| Box Name | Type | Description |
|---|---|---|
| Channel | String | Channel name to set Emote-Only Mode for |
| Enabled | Dropdown | Enable/Disable |
moderator:manage:chat_settings Twitch scope.
Toggles Shield Mode on/off for the specified channel. Click here for more information on Shield Mode.
If Channel is empty, SAMMI uses the default Twitch account.
| Box Name | Type | Description |
|---|---|---|
| Channel | String | Channel to toggle Shield Mode for |
| Enabled | Dropdown | Enable/Disable |
moderator:manage:shield_mode Twitch scope.
Starts a commercial on the specified channel.
Can only be started by the broadcaster's account (will fail if sent as another account)
| Box Name | Type | Description |
|---|---|---|
| Channel Name | String | Channel to play the ad on. Leave blank to use default account |
| Duration | number | Requested length of commercial, in seconds. May result in a different duration to request. Should not be more than 180 seconds. |
| Save Variable As | String | Variable to save the result |
Returns an object with the following variables:
| Variable name | Type | Description |
|---|---|---|
| length | number | Duration of the commercial, in seconds |
| message | string | A message that indicates whether Twitch was able to serve an ad |
| retry_after | number | The number of seconds you must wait before running another ad. |
undefined if Twitch rejects the ad request.
Updates a channel’s information, such as category, title, language, and tags. Leave a box blank to not update that information. Requires at least 1 field to update.
If Channel is empty, SAMMI uses the default Twitch account.
| Box Name | Type | Description |
|---|---|---|
| Channel | String | Channel name to change the information for |
| Category | String | Category of the stream (game name, “Just Chatting”, etc.) |
| Language | Dropdown | The ISO 639-1 2 letter language code. Select from dropdown menu or manually input |
| Title | String | Title of the stream |
| Tags | Stringified array | Tags to apply to the channel, as a stringified array (["Tag1", "Tag2"]) |
channel:manage:broadcast Twitch scope.
Enabling this setting prevents users from posting non-unique messages to the channel.
It can be used to combat spam so that users cannot send the same things in chat multiple times.
If Channel is empty, SAMMI uses the default Twitch account.
| Box Name | Type | Description |
|---|---|---|
| Channel | Dropdown | The Twitch channel the command will be used for. |
| Enabled | Choice | Enabled: Turns the setting on. Disabled: Turns the setting off. |
moderator:manage:chat_settings Twitch scope.
Gets AutoMod settings for a Twitch channel. This only works for channels linked and authorized to be used with SAMMI.
If Channel is empty, SAMMI uses the default Twitch account. The response is saved as an object containing the AutoMod level fields returned by Twitch.
| Box Name | Type | Description |
|---|---|---|
| Channel | String | Channel name to get AutoMod settings for. This can be left empty. |
| Save Variable As | String | Name of the variable to save the response as. If the response is 0, AutoMod settings for that function has not been turned on. If it is 1, it has been turned on. |
moderator:read:automod_settings and user:read:email Twitch scopes.
Sets AutoMod settings for a Twitch channel. This only works for channels linked and authorized to be used with SAMMI.
Moderation levels available: as provided by Twitch:
- AutoMod Off
- A Little Moderation
- Some Moderation
- More Moderation
- A Lot of Moderation
| Box Name | Type | Description |
|---|---|---|
| Channel | String | Channel name to get AutoMod settings for. This can be left empty. |
| Level | Dropdown | Dropdown selection of AutoMod levels available. |
moderator:manage:automod_settings Twitch scope.
Adds a new blocked term to the specified Twitch channel.
If Channel is empty, SAMMI uses the default Twitch account.
| Box Name | Type | Description |
|---|---|---|
| Channel | String | Channel name to add new blocked term |
| Term | String | New term to be blocked |
moderator:manage:blocked_terms Twitch scope.
Removes a blocked term from the specified Twitch channel.
If Channel is empty, SAMMI uses the default Twitch account.
| Box Name | Type | Description |
|---|---|---|
| Channel | String | Channel name to add new blocked term |
| Term ID | String | ID of term to be removed. Can be retrieved from Twitch: Get Blocked Terms. |
moderator:manage:blocked_terms Twitch scope.
Warns a user with a specified message. Warnings force users to acknowledge the message you warn them with.
If Channel is empty, SAMMI uses the default Twitch account.
| Box Name | Type | Description |
|---|---|---|
| Channel | String | The channel to warn the specified user in |
| User Name | String | The username of the person to be warned |
| Reason | String | (optional) The reason why you are warning them |
moderator:manage:warnings and user:read:email Twitch scopes.
Blocks a Twitch user for the specified account. For more information, check out the Twitch API Reference Guide for Block User.
| Box Name | Type | Description |
|---|---|---|
| Channel | Dropdown | Twitch account to block the user from. |
| User Name | String | The username of the person to block. |
user:manage:blocked_users and user:read:email Twitch scopes.
Unblocks a Twitch user for the specified account. For more information, check out the Twitch API Reference Guide for Unblock User.
| Box Name | Type | Description |
|---|---|---|
| Channel | Dropdown | Twitch account to unblock the user from. |
| User Name | String | The username of the person to unblock. |
user:manage:blocked_users and user:read:email Twitch scopes.
Flags a Twitch user as suspicious in the specified channel. For more information, check out the Twitch API Reference Guide for Add Suspicious Status to Chat User.
| Box Name | Type | Description |
|---|---|---|
| Channel | Dropdown | Twitch channel to flag the user in. |
| User Name | String | The username of the person to flag. |
| Status | Dropdown | Suspicious user status to apply: Active Monitoring or Restricted. |
moderator:manage:suspicious_users and user:read:email Twitch scopes.
Removes the suspicious user status from a Twitch user in the specified channel. For more information, check out the Twitch API Reference Guide for Remove Suspicious Status From Chat User.
| Box Name | Type | Description |
|---|---|---|
| Channel | Dropdown | Twitch channel to remove the status in. |
| User Name | String | The username of the person to update. |
moderator:manage:suspicious_users and user:read:email Twitch scopes.