Skip to main content
POST
Cancel Flow Enrollments

Authorizations

X-API-Key
string
header
required

Body

application/json
flowPlanId
string | null
required

Existing flow plan id. Use the exact flowPlanId returned by create_flow_plan, list_flow_plans, or get_flow_workspace.

queueItemIds
(string | null)[] | null

Enrollment queue item ids to cancel. Use exact queueItemId values from list_flow_plan_enrollments or get_flow_workspace required actions; omit to cancel all cancellable queue items in the flow.

Response

Tool result.