Skip to navigation
Paperwork APISpaces

Open a redlining session on a Word document

View as Markdown

Opens an editing session on a .docx file so you can rewrite it with tracked changes.

{ "ttl": 86400 }

ttl is seconds until the session expires, from 60 to 604800 (one week); it defaults to the redlining service’s own default. Nothing is stored back into your corpus until you call flush.

Only a Word document can be redlined. Everything else answers 422.

Learn more: Redlining

Authentication

AuthorizationBearer

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

Path parameters

refstringRequired>=1 character
spaceIdstringRequired

Request

This endpoint expects an object.
ttlintegerOptional60-604800

Response

The open session.
object"redline_session"
idstring
fileIdstring
expiresAtstring
revisioninteger-9007199254740991-9007199254740991

Errors

404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error