update_document_status
Change a document's lifecycle when the user wants a snapshot, a review, or to publish. Pass documentId and status as an action verb — snapshot, review, or publish — not a version status. snapshot saves a read-only copy of the current draft, review opens that draft for comments, and publish makes it the published version. Each one leaves a fresh draft for later edits. Returns previousStatus and status as version statuses such as DRAFT, SNAPSHOT, REVIEW, or PUBLISHED, the same values list_document_versions filters on. Not move, which files documents and folders into a folder, and not a way to check whether an edit is still running.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"documentId": "<documentId>",
"status": "<status>"
},
"name": "update_document_status"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | Yes | Action verb, not a version status. snapshot saves a read-only copy of the current draft. review opens that draft for comments. publish makes it the published version. Do not pass DRAFT, REVIEW, PUBLISHED, or SNAPSHOT — those are the statuses list_document_versions returns and filters on. | |
| documentId | Yes | The document whose current draft should change status. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | Yes | Version status after the change, such as SNAPSHOT, REVIEW, or PUBLISHED. Not an action verb. | |
| documentId | Yes | ||
| previousStatus | Yes | Version status before the change, such as DRAFT. Not an action verb. | |
| documentVersionId | Yes | ||
| newDraftDocumentVersionId | No |