Update Workflow Status

PUT 
/workflows/:workflowId/status

Publish a workflow or send it back to draft. Publishing validates the definition in full and activates the triggers; a definition that fails validation is rejected with 422 and the workflow stays as it was. Locked and scheduled-paused workflows cannot change status and return 409.

Request

Version stringrequired

API Version

Available optionsv4

workflowId stringrequired

Workflow ID

locationId stringrequired

Sub-account (location) ID the workflow belongs to

application/json

application/json

Body

Bodyrequired

statusstringrequired
Target status. Publishing validates the full definition first and activates the triggers; a definition that fails validation is rejected with 422 and the workflow stays in draft.
Available optionspublisheddraft

Example (auto)

{
  "status": "published"
}

application/json

Status changed

application/json

Schema

Schema

workflowIdstringrequired

Workflow ID

statusstringrequired
The status the workflow now has
Available optionspublisheddraft

Example (auto)

{
  "workflowId": "b1b0de82-3efb-4d63-83f6-13c50aef208c",
  "status": "published"
}