Types

OnboardingFlowCreate

The body that creates an onboarding flow.

namerequired
string
The flow's display name. Names need not be unique.
expiry_type
string | null
How often a respondent completes the flow again: `daily`, `one_month`, `three_month`, `six_month`, `twelve_month` or `never_expire`. Defaults to `twelve_month`.One of: daily, one_month, three_month, six_month, twelve_month, never_expire
mode_type
string | null
`continuous` lets a respondent change answers at any time; `versioned` keeps each completion as it was. Defaults to `continuous`.One of: continuous, versioned
user_types
array | null
The user types the flow can onboard: `investor`, `advisor` or both. Defaults to investor.

Used by (1)