Skip to main content
POST
Create Draft Flow Plan

Authorizations

X-API-Key
string
header
required

Body

application/json
flow
object | null
required

Pass flow as a JSON object, not a JSON-encoded string. Put the complete root object inside flow (flow.root), never beside it. Options, AI qualification, and candidates are optional and use server defaults when omitted.

processingStrategy
string | null

Optional enrollment processing mode saved with the draft for use after publication.

  • This call does not enroll contacts or execute steps.
  • Use manual for Manual Mode, where contacts/signals wait for explicit enrollment.
  • Use default for standard Auto-Enrollment, or new_members_only only when the user explicitly asks for new source members only.
  • All three modes support flow.customVariables; custom inputs do not require Manual mode.
extendedResponse
boolean
default:false

Include operational data after creation: cost, enrollment counts, a limited awaiting-contact page, source status, and available enrollment actions. Defaults to false.

awaitingLimit
integer
default:10

Maximum awaiting contacts to include when extendedResponse is true.

Response

Tool result.