Skip to main content
POST
/
api
/
v1
/
workflow
/
{workflowId}
/
executions
/
cancel
Cancel workflow executions by phone number
curl --request POST \
  --url https://prod.featherhq.com/api/v1/workflow/{workflowId}/executions/cancel \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "phoneNumber": "+14155551234"
}
'
{
  "cancelledCount": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.featherhq.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
workflowId
string<uuid>
required

Body

application/json
​
phoneNumber
string
required

Phone number in E.164 format

Pattern: ^\+[1-9]\d{1,14}$
Example:

"+14155551234"

Response

Agent workflow executions cancelled successfully

​
cancelledCount
number
required

Number of executions that were cancelled