v1Resources/Social Inbox/postHide, unhide or delete a comment

Hide, unhide or delete a comment

Hides a comment (it stays on the network but out of public view; unhide undoes it) or deletes it from the network. Deleting cannot be undone: the inbox keeps the row, marked deleted, and resolves it. Each works only where the network allows it. To ban a YouTube commenter use the youtube endpoint.

post/api/v1/inbox/{kind}/{id}/moderate
inbox:write
Query parameters
kindstring (comment | message | mention)required
The kind of item: a comment, a direct message conversation or a mention.
idstringrequired
The item's id, from the inbox list.
Request body
actionstring (hide | unhide | delete)required
What to do to the comment.
Response
dataobjectoptional
okbooleanoptional
True when the request succeeded.
actionstringoptional
The action that was applied.
changedbooleanoptional
False when the comment was already in that state.
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
post/api/v1/inbox/{kind}/{id}/moderate
Your API key
kind *
id *
Request body*
{
  "data": {
    "ok": true,
    "action": "hide",
    "changed": true
  }
}

New to the Synup API?