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 for all selected items. Use the exact flowPlanId returned by create_contact_sequence, add_contact_action, find_mcp_enrollment, create_flow_plan, list_flow_plans, or get_flow_workspace.

queueItemIds
(string | null)[] | null

Exact queueItemId values from list_flow_plan_enrollments or get_flow_workspace required actions.

  • Do not supply with enrollmentIds.
  • Omit both ID lists only to cancel all cancellable work in a normal flow; Dynamic Actions require explicit IDs.
enrollmentIds
(string | null)[] | null

Exact enrollmentId values from create_contact_sequence, add_contact_action, find_mcp_enrollment, get_flow_enrollment, or enrollment lists.

  • Supports normal flows and Dynamic Actions.
  • All IDs must belong to flowPlanId.
  • Do not pass queueItemId or prospectId here, and do not supply with queueItemIds.

Response

Tool result.