Health
Agents
Agent Shares
Workflows
- POSTCreate agent workflow
- GETList agent workflows
- GETGet agent workflow
- PATCHUpdate agent workflow
- DELDelete agent workflow
- POSTCreate workflow execution
- POSTBulk create workflow executions
- GETGet workflow execution
- PUTUpdate workflow execution
- DELDelete workflow execution
- GETList workflow executions
- POSTPause workflow execution
- POSTResume workflow execution
- POSTCancel workflow execution
- POSTCancel workflow execution by lead ID
- POSTCancel workflow executions by phone number
- POSTCancel all workflow executions by phone number
Phone Numbers
- POSTConnect Twilio account
- DELRemove inbound dispatch rule
- POSTCreate inbound dispatch rule
- DELDelete phone number
- PUTUpdate outbound dispatch rules with bulk agent IDs
- GETList organization phone numbers
- GETGet phone number by E.164 format
- GETSearch available Twilio phone numbers
- POSTPurchase a Twilio phone number
- POSTLink SMS agent to phone number
- POSTUnlink SMS agent from phone number
Bridging Numbers
SMS Threads
Knowledge Base
- GETGet knowledge base collections
- GETGet knowledge base files
- POSTAdd file to collection
- DELDelete knowledge base collection
- POSTCreate knowledge base collection
- POSTCreate knowledge base file
- DELDelete knowledge base file
- POSTGenerate presigned URL for uploading a file
- DELRemove file from collection
- PATCHUpdate file status
- POSTView knowledge base file
Tools
Integrations
Squad
Calendars
Calendar Schedules
Calendar Event Types
Calendar Bookings
Calendar Connections
Email Domains
Reports
DNC
Testing Lab
Agent Test
Configuration
Cancel workflow executions by phone number
Copy
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"
}
'Copy
{
"cancelledCount": 123
}Workflows
Cancel workflow executions by phone number
Cancel all running agent workflow executions for a given phone number. Returns the count of cancelled executions.
POST
/
api
/
v1
/
workflow
/
{workflowId}
/
executions
/
cancel
Cancel workflow executions by phone number
Copy
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"
}
'Copy
{
"cancelledCount": 123
}Authorizations
Path Parameters
Body
application/json
Phone number in E.164 format
Pattern:
^\+[1-9]\d{1,14}$Example:
"+14155551234"
Response
Agent workflow executions cancelled successfully
Number of executions that were cancelled
⌘I