Skip to content

Comments & Replies API

Comment features depend on the connected SNS platform’s capability scope and current account permissions.

MethodPathPurpose
GET/v1/brand/commentsList comments
GET/v1/brand/comments/{comment_id}Get comment details
POST/v1/brand/commentsPost a top-level comment on a post
POST/v1/brand/comment-refresh-jobsRequest a comment refresh
GET/v1/brand/comment-refresh-jobs/{id}Check refresh job status
POST/v1/brand/comments/{comment_id}/moderation-actionsRequest 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.

MethodPathPurpose
POST/v1/brand/reply-jobsCreate reply job
GET/v1/brand/reply-jobsList 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.

Responses may include the following availability and recovery indicators:

  • permission_required: Missing required permission; can be recovered via re-authentication
  • permission_unverified: Permission status cannot be determined conclusively
  • review_disabled: Feature is disabled under current app review policies
  • unsupported: Platform does not support this operation
  • reauthorize: Re-authenticate the SNS connection
  • contact_support: Support contact required