Comments: setModerationStatus
Stay organized with collections
Save and categorize content based on your preferences.
Sets the moderation status of one or more comments. The API request must be authorized by the owner of the channel or video associated with the comments.
Quota impact:
A call to this method has a
quota cost
of 50 units.
Common use cases
Request
HTTP request
POST https://www.googleapis.com/youtube/v3/comments/setModerationStatus
Parameters
The following table lists the parameters that this query supports. All of the parameters listed are query parameters.
Parameters
|
Required parameters
|
id
|
string
The
id
parameter specifies a comma-separated list of IDs that identify the comments for which you are updating the moderation status.
|
moderationStatus
|
string
Identifies the new moderation status of the specified comments.
Acceptable values are:
heldForReview
– Marks a comment as awaiting review by a moderator.
published
– Clears a comment for public display.
rejected
– Rejects a comment as being unfit for display. This action also effectively hides all replies to the rejected comment.
|
Optional parameters
|
banAuthor
|
boolean
The
banAuthor
parameter lets you indicate that you want to automatically reject any additional comments written by the comment's author. Set the parameter value to
true
to ban the author.
Note:
This parameter is only valid if the
moderationStatus
parameter is also set to
rejected
.
|
Request body
Do not provide a request body when calling this method.
Response
If successful, this method returns an HTTP
204
response code (
No Content
).
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
|
Try it!
Use the
APIs Explorer
to call this API and see the API request and response.
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 2024-01-19 UTC.
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"Missing the information I need"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"Too complicated / too many steps"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"Out of date"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"Samples / code issue"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]