---
title: "Transition document lifecycle"
method: POST
path: "/documents/document-lifecycle-transition"
tags: ["Document AI — DMS"]
---

# Transition document lifecycle

`POST /documents/document-lifecycle-transition`

## Request

- Base URL: `https://api.paperoffice.ai/latest`
- URL: `https://api.paperoffice.ai/latest/documents/document-lifecycle-transition`
- Auth: HTTP bearer

Change the lifecycle status of a document. Only allowed transitions are possible.

## Request body

- object
  - `pofid` string, required: PaperOffice File ID
  - `new_state` 'draft' | 'in_review' | 'approved' | 'published' | 'archived' | 'expired' | 'superseded', required: New lifecycle state.
  - `comment` string: Optional comment for the lifecycle transition.

## Response `200`

Success

- SuccessEnvelope: Success envelope. Payload fields are endpoint-specific (top-level fields, `result`/`job_result` for jobs, `data` on some account endpoints).
  - `status` 'success', required
  - `processing_time` union
    - string
    - number
  - `_billing` object

## Other responses

- `4XX`: Error
- `5XX`: Error

---

[API](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api.md) · [All operations](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api/revisions/c6a6228a4509?raw)