POST/social-inbox/items/{id}/state

Moderates a comment on the platform: hide, unhide, or delete.

https://api.postfa.st/Auth: pf-api-keyRate limit: 200 requests per hour

DELETE cannot be undone

DELETE removes the comment on the platform itself, not just from the Social Inbox. There is no way to restore it afterwards, so confirm the action in your own UI before calling this route.

If you only want the comment out of public view, use HIDE: it is reversible with UNHIDE.

Platform support

HIDE and UNHIDE work on TikTok, Instagram, Facebook Pages, and Threads.

DELETE is unavailable on Threads and returns inbox.deleteNotSupported there.

Moderation performed directly on the platform syncs back into the item's state, so the two views stay in step.

Path parameters

idstring (UUID)required

The comment item id, from /social-inbox/conversations/{id}/items. This is the item id, not the conversation id.

Request body

actionstringrequired

What to do with the comment. An unrecognized value returns inbox.unsupportedAction.

HIDEUNHIDEDELETE

Response

201 Created The updated item, with state reflecting the new moderation state.

idstring (UUID)required

Item id. This is the value the reply, private-reply, and state routes take as their path parameter.

conversationIdstring (UUID)required

Conversation the item belongs to.

kindstringrequired

Item type. Always COMMENT today.

directionstringrequired

INBOUND for a comment you received, OUTBOUND for a reply you sent.

INBOUNDOUTBOUND
externalItemIdstring | nulloptional

The platform's comment id. null on an outbound reply that is still sending.

parentExternalItemIdstring | nulloptional

Platform id of the parent comment, for threading.

authorUsernamestring | nulloptional

Author's username, when the platform exposes it.

textstring | nulloptional

Comment or reply body.

statestringrequired

Moderation state on the platform, changed via the state route.

VISIBLEHIDDENDELETED
deliveryStatusstring | nulloptional

Outbound items only: how far the send got. null on inbound comments.

PENDINGSENTFAILED
authoredByUserIdstring (UUID) | nulloptional

Workspace member who sent an outbound item. null for replies sent with an API key, because keys are workspace-scoped rather than user-scoped.

platformCreatedAtISO 8601required

When the platform recorded the comment.

createdAtISO 8601required

When PostFast stored the item.

canPrivateReplyboolean | nulloptional

Instagram inbound comments: whether this comment is still eligible for /social-inbox/items/{id}/private-reply. null elsewhere.