Open a redlining session on a Word document

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

1 { "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

Opens an editing session on a `.docx` file so you can rewrite it with tracked changes. ```json { "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](https://docs.cloudraker.com/api/cloud-raker-api/redline/flush-redline-session). Only a Word document can be redlined. Everything else answers `422`. **Learn more:** [Redlining](https://docs.cloudraker.com/developers/file-tools)

Authentication

AuthorizationBearer

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

Path parameters

refstringRequired>=1 character

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

$	curl -X POST https://api.cloudraker.com/v1/files/ref/redline \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"object": "string",
3	"id": "rdl_01K9Z6P2R4",
4	"fileId": "string",
5	"expiresAt": "string",
6	"revision": 1
7	}