Inbox · Comments

Set comment moderation status

Sets comment moderation status.

POSThttps://api.pozy.ai/v1/inbox/comments/{postId}/{commentId}/moderation
setCommentModeration

Guides: Comments, YouTube

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the engagement resource group disabled get 403 resource_group_disabled. Authentication

Path parameters

NameTypeNotes
postIdrequiredstring
commentIdrequiredstring

Request body

application/json, required

  • accountIdstringrequired
  • platformstringrequired

    One of youtube.

  • moderationStatusstringrequired

    One of published, rejected, heldForReview.

  • banAuthorboolean

Example

curl -X POST "https://api.pozy.ai/v1/inbox/comments/6108a2cc742cb4e991051e0c/6cc7605fa43607e4ad43b1d4/moderation" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "accountId": "696e0b682d0a31188e7a2ba9",
  "platform": "youtube",
  "moderationStatus": "published"
}'

Response

200 on success

  • successboolean
200 response
{
  "success": true
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is read-only, scoped to other profiles, or has this resource group disabled.
404not_foundNothing with that id exists in your workspace.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in Comments