Types

OnboardingFlowUpdate

The body that changes an onboarding flow. Send only what changes.

name
string
The flow's display name.
expiry_type
string
How often a respondent completes the flow again: `daily`, `one_month`, `three_month`, `six_month`, `twelve_month` or `never_expire`.One of: daily, one_month, three_month, six_month, twelve_month, never_expire
mode_type
string
`continuous` lets a respondent change answers at any time; `versioned` keeps each completion as it was.One of: continuous, versioned
user_types
string[]
The user types the flow can onboard: `investor`, `advisor` or both.
definition
object | null
The editor's layout for the flow. It is kept as sent and never read by the API. Left alone when you do not send it.
routes
The whole routing graph. It replaces the stored one, and an empty list clears it. List each route after the route that reaches its `from_form_id`; the start form is the only form no route has to reach. Left alone when you do not send it.

Used by (1)