Skip to navigation
Paperwork APIRedline

Comment on the text an anchor resolves to

View as Markdown

Adds a comment anchored to the text anchorText matches.

{ "anchorText": "thirty (30) days", "body": "Sixty days is the market standard here." }

occurrence (1-based) picks a match when the anchor is ambiguous. author names the comment’s author in Word’s review pane; it defaults to CloudRaker.

Learn more: Redlining

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

sessionIdstringRequired>=1 character

Request

This endpoint expects an object.
anchorTextstringRequired>=1 character
bodystringRequired>=1 character
occurrenceintegerOptional<=9007199254740991
authorstringOptional>=1 character

Response

The new comment id and revision.
revisioninteger-9007199254740991-9007199254740991
resultobject
summaryobject

Errors

400
Bad Request Error
404
Not Found Error
429
Too Many Requests Error