Skip to navigation

Edit a session

View as Markdown

Applies one edit to the document, as a tracked change by default.

{ "op": "replace", "anchorText": "thirty (30) days", "replacement": "sixty (60) days" }

Four operations: replace and deleteText act on anchor text, fill applies a list of replacements in one pass, and insertMarkdown adds new paragraphs before or after an anchor (or at the end). Set tracked: false to write the change silently instead.

The response carries the new revision and the ids of the tracked changes the edit produced. Those ids are positional and only valid at that revision.

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.
openumRequired
Allowed values:
anchorTextstringOptional
occurrenceintegerOptional<=9007199254740991
allbooleanOptional
replacementstringOptional
markdownstringOptional
positionenumOptional
Allowed values:
fieldslist of objectsOptional
trackedbooleanOptional
authorstringOptional

Response

The edit outcome.
revisioninteger-9007199254740991-9007199254740991
summaryobject

Errors

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