Skip to main content
POST
Add Manual Flow Enrollment

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.

manualEnrollment
object | null
required

Contact and optional first-email details. The flow plan is set only through the top-level flowPlanId. Omit or pass null for options to use normal exclusion checks and priority 0.

enrollmentMode
enum<string> | null

Optional override of the flow plan's enrollment behavior.

  • For a plain request such as 'Add contact X to flow Y', do not set this field.
  • A draft flow always adds an omitted mode to Awaiting.
  • Set enroll only when the user explicitly asks to enroll or start the contact immediately; this requires a published flow.
  • Set manual only when the user explicitly asks for manual enrollment or to add the contact to Awaiting without starting it.
Available options:
manual,
enroll,
null
includeWorkspaceRefresh
boolean
default:true

Include refreshed counts and first awaiting page in the response.

Response

Tool result.