Ban User
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 (max 500 characters) |
If the reason exceeds 500 characters, SAMMI will show a warning and automatically truncate it before sending the request.
Requires the
moderator:manage:banned_users and user:read:email Twitch scopes.
Twitch API Endpoint: POST /helix/moderation/bans
| Request Field | Type | Description |
|---|---|---|
| broadcaster_id | String | The ID of the broadcaster whose chat room the user is banned from |
| moderator_id | String | The ID of the moderator or broadcaster banning the user |
| data.user_id | String | The ID of the user to ban |
| data.reason | String | Optional. The reason for the ban |