Skip to main content
POST
Cancel Awaiting Flow Items

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; do not use the read-only MCP Dynamic Actions flowPlanId here.

itemIds
(string | null)[] | null
required

Awaiting candidate ids to cancel. Get exact values from get_flow_workspace.awaiting.items[].candidate_id; do not pass enrollmentId or queueItemId here. At least one id is required; omitting ids never cancels all awaiting items.

Minimum array length: 1
includeWorkspaceRefresh
boolean
default:true

Include refreshed counts and first awaiting page in the response.

Response

Tool result.

requestedItemIds
string[]
required
canceledCount
integer
required
workspaceRefresh
object | null
required
nextSteps
string[]
required