LiveChatBans: 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.

Request

HTTP request

POST https://www.googleapis.com/youtube/v3/liveChat/bans

Authorization

This request requires authorization with at least one of the following scopes (read more about authentication and authorization).

Scope
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

Parameters

The following table lists the parameters that this query supports. All of the parameters listed are query parameters.

Parameters
Required parameters
part string
The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response returns. Set the parameter value to snippet.

Request body

Provide a liveChatBan resource in the request body. For that resource:

  • You must specify a value for these properties:

    • snippet.liveChatId
    • snippet.type
    • snippet.bannedUserDetails.channelId

  • You can set values for these properties:

    • snippet.banDurationSeconds

Response

If successful, this method returns a liveChatBan resource in the response body.

Errors

The following table identifies error messages that the API could return in response to a call to this method. Please see the error message documentation for more detail.

Error type Error detail Description
forbidden (403) insufficientPermissions You do not have the necessary permissions to ban a user from the specified live chat.
forbidden (403) liveChatBanInsertionNotAllowed The specified ban cannot be created. This error can occur if the request attempts to ban the chat owner or another moderator.
invalidValue (400) invalidChannelId The specified channel ID cannot be found.
invalidValue (400) invalidLiveChatId The snippet.liveChatId value specified in the request is invalid. Check the associated liveBroadcast resource to ensure that you have the correct value.
notFound (404) liveChatNotFound The specified live chat cannot be found. Check the associated liveBroadcast resource to ensure that you are setting the the snippet.liveChatId property to the correct value.
notFound (404) liveChatUserNotFound The live chat user you are trying to ban cannot be found.
required (400) bannedUserChannelIdRequired The liveChatBan resource submitted in the request body must specify a value for the snippet.bannedUserDetails.channelId property.
required (400) liveChatIdRequired The liveChatBan resource submitted in the request body must specify a value for the snippet.liveChatId property.

Try it!

Use the API Explorer to call this method on live data and see the API request and response.