OnboardingSettings
A request or response body; the type column links to the schemas it refers to.
OnboardingSettings
| Field | Type | Required | Description |
|---|---|---|---|
| welcome_markdown | string | null | yes | The welcome message shown at the top of the onboarding page, as markdown, or null when none is set. The page's own guidance — where to start, the help & support pages and the support address — follows it either way. |
| updated_at | string (date-time) | null | yes | When the welcome message was last set or cleared, or null when it never was. |
jsonExample
{
"welcome_markdown": "## Welcome aboard\n\nStart with the **Safety induction** pathway on your dashboard.",
"updated_at": "2026-01-01T00:00:00.000Z"
}