Comments & Replies API
Comment features depend on the connected SNS platform’s capability scope and current account permissions.
Comment Endpoints
Section titled “Comment Endpoints”| Method | Path | Purpose |
|---|---|---|
GET | /v1/brand/comments | List comments |
GET | /v1/brand/comments/{comment_id} | Get comment details |
POST | /v1/brand/comments | Post a top-level comment on a post |
POST | /v1/brand/comment-refresh-jobs | Request a comment refresh |
GET | /v1/brand/comment-refresh-jobs/{id} | Check refresh job status |
POST | /v1/brand/comments/{comment_id}/moderation-actions | Request hide or delete action |
Posting a top-level comment:
{ "idempotency_key": "comment-001", "target": { "content_id": "<content_id>" }, "text": "Thank you for checking out our post."}Current action values for moderation are hide or delete. Actual execution depends on platform and comment state.
Reply Jobs
Section titled “Reply Jobs”| Method | Path | Purpose |
|---|---|---|
POST | /v1/brand/reply-jobs | Create reply job |
GET | /v1/brand/reply-jobs | List reply jobs |
GET | /v1/brand/reply-jobs/{reply_job_id} | Get reply job status |
{ "comment_id": "<comment_id>", "idempotency_key": "reply-001", "text": "Thank you for reaching out."}An HTTP 202 on reply creation means the job was validated, stored, and queued. Verify final status via reply_job_id.
Availability & Recovery States
Section titled “Availability & Recovery States”Responses may include the following availability and recovery indicators:
permission_required: Missing required permission; can be recovered via re-authenticationpermission_unverified: Permission status cannot be determined conclusivelyreview_disabled: Feature is disabled under current app review policiesunsupported: Platform does not support this operationreauthorize: Re-authenticate the SNS connectioncontact_support: Support contact required