Update a Workflow state to STARTED triggering any processes related to this specific state.

POST http://api.kompliant.com/workflow.start (OpenAPI specification)

Usage Info

Start a workflow by updating its state from CREATED to STARTED, triggering initial processing tasks.

The triggered tasks depends on the account configuration.

Request

Parameter	Type	Required	Description
workflow_id	string	Yes	The identifier for the Workflow.

{
  "workflow_id": "w_7h1EpxerrZQyLnRC1EQ9Ck",
}

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

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

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

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 started with this method.
Workflow	WORKFLOW_ENDED	The Workflow is in the `ENDED` state. Only Workflows in the `CREATED` state can be started with this method.