Comments

Leave a comment

Create a top-level comment, optionally anchored to a text range (anchor_text + anchor_prefix/anchor_suffix) or a block (block_id). Requires comment access on the report (can_comment_report) — 403 otherwise. Fires comment.created (and comment.mentioned per unique @handle) webhooks. Scope: comments:write.

post/reports/{id}/comments

Request

  • Base URL: https://commareports.com/api/v1
  • URL: https://commareports.com/api/v1/reports/{id}/comments
  • Auth: HTTP bearer

Request body

bodystring required
block_idstring

Anchor to a block element id.

anchor_textstring

Exact text the comment anchors to.

anchor_prefixstring

Disambiguating text before the anchor.

anchor_suffixstring

Disambiguating text after the anchor.

Response

Comment created.

idstring uuid required
bodystring required
status'open' | 'resolved' required
created_atstring date-time required

Changes

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