OnboardingFlow

An onboarding flow: the journey a respondent follows, with its routing graph.

idrequired string (uuid): The flow id.
namerequired string: The flow's display name. Names need not be unique.
statusrequired string: draft or published. Read-only: change it with the publish and unpublish actions.One of: draft, published
expiry_typerequired string: How often a respondent must complete 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_typerequired string: continuous lets a respondent change answers at any time; versioned keeps each completion as it was.One of: continuous, versioned
user_typesrequired string[]: The user types the flow can onboard: investor, advisor or both.
routesrequired object[]: The routing graph: the edges a respondent can follow between the flow's forms, in the order they were written. Empty until a graph is written.
definitionrequired object | null: The editor's layout for the flow. Opaque to the API: it is kept as sent.
form_countrequired integer: How many forms the flow has, the start form included.
start_form_idrequired string | null (uuid): The id of the flow's start form, the form every respondent sees first.
created_atrequired string (date-time): When the flow was created.
updated_atrequired string | null (date-time): When the flow last changed.

Used by (7)