Transition Form Instance

Advance or revert a form instance to a new state in its configured workflow. Requires READ, ADMIN, or MANAGE_TO_DO permissions.

Parameters

name * are required parameters	data type	description
instanceId*	string	The unique identifier of the form instance
body.state*	string	The target state to transition to
body.data	object	Any form data to save during the transition
body.comment	object	Comment to save and include in notifications

Return Value

The updated form instance with the new state applied.

Error Codes

• 400 Bad Request: Returned when the transition is not valid for the current state.
• 401 Unauthorized: Returned when permissions are insufficient.

Examples

bash

curl -X PUT "https://app.wombat.software/api/{targetPath}/form/:instanceId/transition" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer ..." \
  -d '{"state": "submitted", "comment": {"type": "doc", "content": []}}'