Skip to content

Transition Document

Transition a document to a new state in its workflow. Transitioning to the final state publishes the document. Requires the DOCUMENTS feature flag and ADMIN, UPDATE_DOCUMENT, TRANSITION_DOCUMENT, or MANAGE_DOCUMENTS permissions.

Parameters

name * are required parametersdata typedescription
documentId*stringThe unique identifier of the document
body.state*stringThe target state to transition to

Return Value

The updated document with the new state. If the last workflow state, the document is published.

Examples

bash
curl -X POST "https://app.wombat.software/api/{targetPath}/document/:documentId/transition" \
  -H "Content-Type: application/json" \
  -H "Authentication: Bearer ..." \
  -d '{"state": "published"}'

ENDPOINTS

post/api/{targetPath}/document/:documentId/transition