Workflow

Creates/saves a workflow action

Creates or updates a workflow action from the properties specified in the payload. Returns the created workflow action.

Tip: Passing a stepId in the body also attaches the new action to that step as a side-effect. The separate POST /api/v1/workflow/steps/{stepId}/actions endpoint is only needed when attaching an action that already exists; for new actions created via this endpoint, stepId performs both the create and the attach in a single call.

Anyone / public role: there is no magic "anyone" constant for whoCanUse or actionNextAssign. Use the CMS Anonymous role id (654b0931-1027-41f7-ad4d-173115ed8ec1) on most installs, or look up the actual id by inspecting an existing System Workflow action.

post/api/v1/workflow/actions

Request body

actionIdstring
schemeIdstring required
stepIdstring
actionNamestring required
whoCanUsestring[]
actionIconstring
actionAssignableboolean required
actionCommentableboolean required
showOnstring[] required
actionRoleHierarchyForAssignboolean required
actionNextStepstring required
actionNextAssignstring
actionConditionstring
metadataobject

Response

Workflow action created successfully

i18nMessagesMapobject
permissionsstring[]

Changes