PostZen
Inbox

Hide a comment

POST
/v1/inbox/comments/{postId}/{commentId}/hide

Hides a comment so only its author still sees it. Requires a read-write API key and the account's comment-management scope. canHide on the comment says whether the platform allows it: Facebook reports it per comment, and Threads only supports hiding top-level replies on the connected account's own posts — hiding one there also hides the replies beneath it.

Authorization

bearerAuth
AuthorizationBearer <token>

PostZen API key.

In: header

Path Parameters

postId*string

Post the comments belong to. Accepts a PostZen post id — resolved to the id the post was published under for accountId — or the platform's own post/media id, which is the common case because the inbox covers every post the account has, not only the ones PostZen published. Instagram and Facebook also accept a comment id here.

commentId*string

Platform id of the comment to hide or unhide.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/inbox/comments/string/string/hide" \  -H "Content-Type: application/json" \  -d '{    "accountId": "k17d8s9f0a1b2c3d4e5f6g7h8i"  }'
{  "status": "success",  "commentId": "17912345678901234",  "hidden": true,  "platform": "instagram"}
{  "error": "The inbox supports Instagram, Facebook and Threads accounts only.",  "code": "platformUnsupported",  "platform": "tiktok"}
{  "error": "Unauthorized"}
{  "error": "Reconnect the account to grant PostZen access to its comments.",  "code": "platformCapabilityMissing",  "platform": "facebook"}
{  "error": "That post could not be found.",  "code": "postNotFound"}
{  "error": "This connection needs to be reauthorized before its comments can be read.",  "code": "connectionDead",  "platform": "instagram"}
{  "error": "(#4) Application request limit reached",  "code": "4",  "platform": "instagram",  "platformError": "(#4) Application request limit reached"}
{  "error": "Failed to create post"}
{  "error": "Unsupported get request.",  "code": "100",  "platform": "facebook",  "platformError": "Unsupported get request."}

Delete a comment DELETE

Deletes a comment. Requires a read-write API key and the account's comment-management scope. `canDelete` on the comment says whether the platform allows it: Facebook reports it per comment, and Threads only allows deleting replies the connected account itself wrote.

Unhide a comment DELETE

Restores a hidden comment. Requires a read-write API key and the account's comment-management scope. On Threads, unhiding a top-level reply also restores the replies beneath it.