Skip to main content
POST
https://api-ai.zixflow.com
/
api
/
ingestion
/
transflow
/
v1
/
{workspace_id}
/
{transflow_id}
/
stop
/
{request_id}
Stop Transflow Execution
curl --request POST \
  --url https://api-ai.zixflow.com/api/ingestion/transflow/v1/{workspace_id}/{transflow_id}/stop/{request_id} \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-workspace-id: <x-workspace-id>'
{
  "status": true,
  "message": "Transflow execution stopped successfully"
}

​
Description

This endpoint allows you to stop a running Transflow workflow execution using the request ID returned from the trigger endpoint.

​
Headers

​
x-api-key
string
required
Your API key for authentication.
​
x-workspace-id
string
required
Your workspace ID for authentication.

​
Path Parameters

​
workspace_id
string
required
The unique identifier of the workspace where the Transflow is configured.
​
transflow_id
string
required
The unique identifier of the Transflow workflow.
​
request_id
string
required
The unique identifier of the workflow execution request to stop. This is returned from the trigger endpoint.

​
Response

​
status
boolean
Indicates whether the call was successful. true if successful, false if not.
​
message
string
Success or error response message.
{
  "status": true,
  "message": "Transflow execution stopped successfully"
}