Cancel Workflow
API to cancel a running workflow execution. You can cancel a workflow by passing any combination of filters in the request body. When multiple parameters are provided, they are ANDed together to narrow down the matching workflow runs.
For example, passing both workflow_slug and recipients will cancel only the workflow runs that match both the given slug and recipients.
Authorizations
Pass as Bearer <API_KEY>. Get API Key from SuprSend dashboard Developers -> API Keys section.
Body
Filter parameters to identify workflow runs to cancel. At least one parameter must be provided. When multiple parameters are passed, they are ANDed together.
Unique execution identifier of the workflow run to cancel. You can find this in the workflow logs on the SuprSend dashboard.
"dsl_xxxx-xxxx-xxxx-xxxx"
List of recipient identifiers (distinct_id or contact info) whose workflow runs should be cancelled.
Idempotency key that was passed when triggering the workflow. Use this to cancel a specific workflow triggered with a known idempotency key.
"a1b2c3d4-xxxx-xxxx-xxxx-ef0123456789"
Slug of the workflow whose runs should be cancelled.
"order-confirmation"
Response
200 - OK
List of workflow execution IDs that were successfully cancelled. Empty array if no matching workflow runs were found.
Unique execution identifier of the cancelled workflow run.