SpecifyDocs

Document comments

/v1/documents/{documentId}/comments

Signed-in sessionLaunch key product.editorOperation document_comments

Path parameters

documentIdstringRequired

Query parameters

expectedAuthorizationVersionstring
threadIdstring
cursorstring

Returns

documentIdstringRequired
epochnumberRequired
canCommentbooleanRequired
viewerActorIdstringRequired
threadsobject[]Required
commentsobject[]Required
nextCursornull | stringRequired

Errors

400, 401, 403, 404, 409, 429 and 503 return {"error": {"code", "message", "correlationId"}}. A call without a valid credential gets 401 before its input is checked, and so does an address that is not an operation: 404 and 400 come only once the credential is accepted. Public operations answer without one.