Skip to main content

Comments API

The /v1/comments endpoints manage scheduled comments — comments that post.buzz publishes on your behalf at a future time (first comments, replies to specific parent comments). This is the API counterpart of the first-comment feature.

Requires authentication.


Schedule a comment​

POST /api/v1/comments

Request body​

FieldTypeRequiredDescription
postIdstringyesThe post the comment belongs to
accountIdstringyesAccount that will publish the comment
textstringyesComment text
scheduledAtstring (ISO 8601)noWhen to publish; omit for as-soon-as-possible
parentCommentIdstringnoPlatform ID of a comment to reply to

Example​

curl -X POST https://<your-api-origin>/api/v1/comments \
-H "Authorization: Bearer sx_live_YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"postId": "pst_abc123",
"accountId": "acc_instagram",
"text": "Link in bio 🔗",
"scheduledAt": "2026-07-15T14:35:00Z"
}'

Response — 200 OK​

{
"data": {
"id": "cmt_01",
"postId": "pst_abc123",
"accountId": "acc_instagram",
"text": "Link in bio 🔗",
"status": "pending",
"scheduledAt": "2026-07-15T14:35:00.000Z"
}
}

List scheduled comments​

GET /api/v1/comments?postId=<id>&status=pending|published|failed

Returns a plain array inside data (no pagination). Filter by post and/or status.

ParameterTypeDescription
postIdstringRestrict to one post
statusstringpending, published, failed

Get a comment​

GET /api/v1/comments/{id}

Returns one scheduled comment inside data; 404 not_found ("Scheduled comment not found") otherwise.


Reschedule a comment​

PATCH /api/v1/comments/{id}

Updates the comment (e.g. a new scheduledAt) and pokes the scheduler so the new time takes effect immediately. Returns the updated comment inside data.


Delete a comment​

DELETE /api/v1/comments/{id}

Only pending comments can be deleted.

Errors​

StatusBody
400{ "error": { "code": "validation_error", "message": "Can only delete pending comments" } }
404{ "error": "Scheduled comment not found" }

Retry a failed comment​

POST /api/v1/comments/{id}/retry

Queues a fresh publish attempt for a failed comment. Returns the scheduled comment inside data (with its status reset for retry).

  • Posts API — posts also accept an inline firstComment; use /v1/comments when you need to schedule, edit, or retry it as its own resource.
  • Comment automation — rule-driven replies to inbound comments.