Usage Info

This method permanently deletes a Workflow entity from the system. Use with caution as this operation cannot be undone and may affect relationships with associated entities. This method is typically used to remove incorrect entries or during testing in sandbox environments.

Note that a Workflow entity cannot be deleted if it is currently in STARTED or ENDED. Check WORKFLOW_STATES for more information about Workflow states.

Request

Authentication: KSig1-HMAC-SHA256

Parameters

Parameter	Type	Required	Description
workflow_id	string	Yes	The ID of the Workflow.

Example

{
  "workflow_id": "w_4PYsekjAX8VMuAOfmW81C7"
}

Response

Data

An empty data object is returned when the completion is successful.

Example

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_6zNzQZHSf26V83BO3uW6dS",
    "version": "2025-03-24"
  },
  "data": {}
}

Errors

Error Code	HTTP Code	Possible Cause
BAD_REQUEST	400	Required parameters not provided.
ENTITY_NOT_FOUND	400	The `workflow_id` provided does not exist.
SYSTEM_RULE_VIOLATION	400	System rule violations are described below

System Rule Violations

When a SYSTEM_RULE_VIOLATION error occurs, the response will include additional entity_type and sub_code fields to provide more specific information:

Entity Type	Sub-code	Description
Workflow	WORKFLOW_STARTED	The Workflow is in the `STARTED` state. Only Workflows in the `CREATED` state can be deleted with this method.
Workflow	WORKFLOW_ENDED	The Workflow is in the `ENDED` state. Only Workflows in the `CREATED` state can be deleted with this method.