Delete Workflow

DELETE 
/workflows/:workflowId

Delete a workflow. This also ends any enrollments in progress, so contacts currently moving through the workflow stop where they are. Treat it as permanent.

Request

Version stringrequired

API Version

Available optionsv3

workflowId stringrequired

Workflow ID

locationId stringrequired

Sub-account (location) ID the workflow belongs to

application/json

Workflow deleted

application/json

Schema

Schema

succeededbooleanrequired

Whether the workflow was deleted

workflowIdstringrequired

Id of the deleted workflow

Example (auto)

{
  "succeeded": true,
  "workflowId": "9e78a2b1c4d5e6f7a8b9c0d1"
}