POpostproxy
Comments

Create comment or reply

Creates a new comment on a published post, or a reply when parent_id is given. The comment is stored immediately with status pending and published to the platform asynchronously.

post/api/posts/{post_id}/comments

Request

  • Base URL
    https://api.postproxy.dev
  • URL
    https://api.postproxy.dev/api/posts/{post_id}/comments
  • Auth
    HTTP bearer

Query parameters

profile_group_idstring

Profile group context for the request. Optional when the API key is scoped to a profile group (that group is used automatically); with a full-access key, defaults to the first profile group in the account.

profile_idstring required

Profile ID

Headers

Idempotency-Keystring

Optional idempotency key (up to 255 characters; a UUID is ideal). Retrying a successful write with the same key replays the original response (with an Idempotent-Replay: true header) instead of executing again. Stored responses are kept for 24 hours; only 2xx responses are stored.

Request body

bodystring required

Comment text content. (The legacy text parameter is still accepted as an alias.)

parent_idstring

ID of comment to reply to (Postproxy ID or external ID). Omit to comment on the post itself.

Response

Comment created with status pending and external_id null; the status updates asynchronously once published to the platform.

idstring

Unique comment identifier (ID)

external_idstring nullable

Platform's native comment ID (null for pending comments)

bodystring

Comment text content

status'synced' | 'pending' | 'published' | 'failed' | 'failed_waiting_for_retry' | 'delivery_unconfirmed'

Comment status. Only published and failed are terminal — treat every other value as still in progress.

errorstring nullable

Error summary if the comment failed to publish (null otherwise)

author_usernamestring nullable

Author's display name or username

author_avatar_urlstring nullable

Stable Postproxy storage URL of the author's profile picture once mirrored; the platform URL until then

author_external_idstring nullable

Author's platform-specific ID

parent_external_idstring nullable

Parent comment's external ID (null for top-level comments)

like_countinteger

Number of likes on the comment

is_hiddenboolean

Whether the comment is hidden

permalinkstring nullable

Direct URL to the comment on the platform (when available)

platform_dataobject nullable

Platform-specific metadata

external_edited_atstring nullable

ISO 8601 timestamp of the last edit made through Postproxy (null if never edited)

posted_atstring nullable

ISO 8601 timestamp when the comment was posted on the platform

created_atstring

ISO 8601 timestamp of record creation

repliesComment[] circular

Changes

No recorded changes to this operation across all 1 revision of this API.