Toggle workflow status
Flips a workflow between running and paused.
This flips whatever the current status is, it does not set a status you choose. Read the workflow first with Get workflow and only call this when status is not already what you want, or two calls in a row will land you back where you started.
Pausing takes effect immediately: the schedule is removed and the trigger stops firing. Starting a workflow again requires a plan that includes workflows; pausing one does not, so a workspace that has lost the capability can still stop a workflow it can no longer start.
Archived workflows cannot be toggled and return a 400. Restore one first with Restore workflow.
This endpoint is limited to 20 requests per minute.
Authorizations
Personal API key.
Path Parameters
ID of the app whose workflows you want to work with.
ID of the workflow, as returned in id by List workflows.
Response
The workflow's new status.
ID of the workflow.
"68b1c0d4e7b91d003c45a1f2"
The status the workflow actually landed in, which is not always the one you asked for.
"active"
Why a restored workflow did not come back active, written for a person to read. null when you toggled the status yourself.
"The schedule already ended, so the workflow stayed inactive."