LiveChatBans
Stay organized with collections
Save and categorize content based on your preferences.
A liveChatBan
resource identifies a YouTube user and a YouTube live chat that the user is banned from participating in.
Methods
The API supports the following methods for liveChatBans
resources:
- insert
- Bans a specific user from participating in the live chat. The API request must be authorized by the channel owner or a moderator of the live chat associated with the ban. Try it now
.
- delete
- Removes a ban that prevents a specific user from contributing to a live chat, thereby enabling the user to rejoin the chat. The API request must be authorized by the channel owner or a moderator of the live chat associated with the ban. Try it now
.
Properties
The following table defines the properties that appear in this resource:
kind
string
Identifies the API resource's type. The value will be youtube#liveChatBan
.
etag
etag
The Etag of this resource.
id
string
The ID that YouTube assigns to uniquely identify the ban.
snippet
object
The snippet
object identifies the banned user and contains details about the ban.
snippet.
liveChatId
string
The live chat to which the ban applies. The live chat ID associated with a broadcast is returned in the liveBroadcast
resource's snippet.liveChatId
property.
snippet.
type
string
The type of ban.Valid values for this property are:
snippet.
banDurationSeconds
unsigned long
The duration of the ban. Only set a value for this property if the ban's type is temporary
. The default value is 300
(5 minutes).
snippet.
bannedUserDetails
object
This object contains information that identifies the banned user.
snippet.bannedUserDetails.
channelId
string
The banned user's YouTube channel ID.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-28 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[[["\u003cp\u003eA \u003ccode\u003eliveChatBan\u003c/code\u003e resource identifies a YouTube user who is banned from a specific YouTube live chat.\u003c/p\u003e\n"],["\u003cp\u003eThe API allows channel owners or moderators to insert a \u003ccode\u003eliveChatBan\u003c/code\u003e to ban a user or delete one to remove the ban.\u003c/p\u003e\n"],["\u003cp\u003eA \u003ccode\u003eliveChatBan\u003c/code\u003e can be either permanent or temporary, and the duration of a temporary ban can be specified in seconds.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eliveChatBan\u003c/code\u003e resource's \u003ccode\u003esnippet\u003c/code\u003e object includes the ID of the live chat, the type of ban, the ban duration (if temporary), and details of the banned user.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eliveChatBan\u003c/code\u003e resource has properties such as \u003ccode\u003ekind\u003c/code\u003e, \u003ccode\u003eetag\u003c/code\u003e, and \u003ccode\u003eid\u003c/code\u003e, which provide general information about the resource, such as the resource type, its ETag, and the ban's unique ID.\u003c/p\u003e\n"]]],["The `liveChatBan` resource manages user bans in YouTube live chats. Key actions include: inserting a ban (`insert`) to prevent a user from participating, and deleting a ban (`delete`) to allow a user to rejoin. The resource identifies the banned user, the live chat, ban type (`permanent` or `temporary`), and ban duration in seconds. The resource properties include `kind`, `etag`, and `id`. Authorization from the channel owner or a moderator is required for both inserting and deleting.\n"],null,["# LiveChatBans\n\nA **liveChatBan** resource identifies a YouTube user and a YouTube live chat that the user is banned from participating in.\n\nMethods\n-------\n\nThe API supports the following methods for `liveChatBans` resources:\n\n[insert](/youtube/v3/live/docs/liveChatBans/insert)\n: Bans a specific user from participating in the live chat. The API request must be authorized by the channel owner or a moderator of the live chat associated with the ban.\n [Try it now](/youtube/v3/live/docs/liveChatBans/insert#try-it).\n\n[delete](/youtube/v3/live/docs/liveChatBans/delete)\n: Removes a ban that prevents a specific user from contributing to a live chat, thereby enabling the user to rejoin the chat. The API request must be authorized by the channel owner or a moderator of the live chat associated with the ban.\n [Try it now](/youtube/v3/live/docs/liveChatBans/delete#try-it).\n\nResource representation\n-----------------------\n\nThe following JSON structure shows the format of a `liveChatBans` resource: \n\n```carbon\n{\n \"#kind\": \"youtube#liveChatBan\",\n \"#etag\": etag,\n \"#id\": string,\n \"#snippet\": {\n \"#snippet.liveChatId\": string,\n \"#snippet.type\": string,\n \"#snippet.banDurationSeconds\": unsigned long,\n \"#snippet.bannedUserDetails\": {\n \"#snippet.bannedUserDetails.channelId\": string\n }\n }\n}\n```\n\n### Properties\n\nThe following table defines the properties that appear in this resource:\n\n| Properties ||\n|---------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies the API resource's type. The value will be `youtube#liveChatBan`. |\n| `etag` | `etag` The Etag of this resource. |\n| `id` | `string` The ID that YouTube assigns to uniquely identify the ban. |\n| `snippet` | `object` The `snippet` object identifies the banned user and contains details about the ban. |\n| snippet.`liveChatId` | `string` The live chat to which the ban applies. The live chat ID associated with a broadcast is returned in the `liveBroadcast` resource's `snippet.liveChatId` property. |\n| snippet.`type` | `string` The type of ban. Valid values for this property are: - `permanent` - `temporary` |\n| snippet.`banDurationSeconds` | `unsigned long` The duration of the ban. Only set a value for this property if the ban's type is `temporary`. The default value is `300` (5 minutes). |\n| snippet.`bannedUserDetails` | `object` This object contains information that identifies the banned user. |\n| snippet.bannedUserDetails.`channelId` | `string` The banned user's YouTube channel ID. |"]]
