Skip to navigation

Export a document as a Word file with tracked changes

View as Markdown

Writes the difference between the ORIGINAL .docx this document was imported from and its current markdown into that Word file as tracked changes, and files the result as a <name>.redlined.docx artifact. Remaining CriticMarkup comments become Word comments. A document that was not imported from a Word file answers 409 no_source_document. Authorization: the same gate as every session route — work_session:read (or comment to write) on the session, OR space:contribute on one of its linked spaces; a desk session only for its owner. Any denial is 404.

Authentication

AuthorizationBearer

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

Path parameters

sessionIdstringRequired
artifactIdstringRequired

Request

This endpoint expects an object.
format"docx"Required

Response

The redlined Word artifact.
dataobject

Errors

400
Bad Request Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error