Skip to main content
POST
/
api
/
ingest
/
sendflow
/
v1
/
{sendflow_id}
/
stop
/
{request_id}
Stop Sendflow Execution
curl --request POST \
  --url https://api-ai.zixflow.com/api/ingest/sendflow/v1/{sendflow_id}/stop/{request_id} \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-workspace-id: <x-workspace-id>'
{
  "success": true,
  "message": "Sendflow execution stopped successfully"
}

​
Description

This endpoint allows you to stop a running Sendflow 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

​
sendflow_id
string
required
The unique identifier of the Sendflow workflow.
​
request_id
string
required
The unique identifier of the workflow execution request to stop. This is returned from the trigger endpoint.

​
Response

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