article-reviews

Create an anchored comment on a request's snapshot (reviewers only).

Changed on
post/api/review/requests/{id}/comments

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

idstring required

Review request ID

Request body

block_indexinteger required

data-block index of the snapshot block this comment anchors to.

bodystring required
quoted_textstring nullable

The anchored text as the editor saw it, for the comment rail.

sentence_endinteger nullable
sentence_startinteger nullable

Sentence range within the block (data-s indices, inclusive). Omit both for a block-level comment (embeds, figures).

Response

Comment created

block_indexinteger nullable
bodystring required
created_atstring required
idstring required
parent_idstring nullable
quoted_textstring nullable
request_idstring required
resolved_atstring nullable
sentence_endinteger nullable
sentence_startinteger nullable

Changes