Skip to main content
POST
Enroll Awaiting Flow Items

Authorizations

X-API-Key
string
header
required

Body

application/json
flowPlanId
string | null
required

Existing flow plan id. Use the exact published 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 enroll. Get exact values from get_flow_workspace.awaiting.items[].candidate_id; do not pass enrollmentId or queueItemId here.

includeWorkspaceRefresh
boolean
default:true

Include refreshed counts and first awaiting page in the response.

customVariablesByItemId
object | null

Optional dictionaries keyed by selected Awaiting candidate id.

  • Omit an item's entry to use its saved values.
  • Each supplied dictionary completely replaces that item's inputs declared by the current plan; omitted declared keys are removed.
  • Unknown submitted keys are errors.
  • Other saved keys remain on the candidate and are excluded from execution.
  • An empty dictionary clears declared inputs and is valid only when none are required.
  • Values cannot be changed after enrollment is requested.
  • Strings must be final text without curly braces; nested variables are not supported.

Response

Tool result.