WorkflowsVersion: v3

Delete Workflow

DEL/workflows/{workflowId}

Limited availability. The workflow API is currently enabled for selected sub-accounts only; any other sub-account receives 403 WORKFLOW_API_NOT_ENABLED_FOR_LOCATION.

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.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:workflows.delete

Auth methods:OAuthPrivate Integration

Token type:Sub-Account Token

Request

Headers

Versionstringrequired

API Version. Send v3.

Available optionsv3

Example:v3

Path Parameters

workflowIdstringrequired

Workflow ID

Example:b1b0de82-3efb-4d63-83f6-13c50aef208c

Query Parameters

locationIdstringrequired

Sub-account (location) ID the workflow belongs to

Example:ve9EPM428h8vShlRW1KT

Response

application/json

Workflow deleted

succeededbooleanrequired

Whether the workflow was deleted

Example:true