Document AI — DMS

Transition document lifecycle

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

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

Request body

pofidstring required

PaperOffice File ID

new_state'draft' | 'in_review' | 'approved' | 'published' | 'archived' | 'expired' | 'superseded' required

New lifecycle state.

commentstring

Optional comment for the lifecycle transition.

Response

Success

status'success' required
_billingobject

Changes

No recorded changes to this operation across all 1 revision of this API.