onboarding

2 endpoints.

GET/api/onboarding Bearer token

Read the onboarding settings

The welcome message the onboarding page opens with — the page an account lands on after its first sign-in while the `onboarding` feature is on (see `GET /api/feature-flags`). Readable whether or not the page is on.

Responses

Status	Description	Body
200	The current onboarding settings.	OnboardingSettings
401	The access token is missing or invalid.	ErrorResponse
500	The onboarding settings could not be read.	ErrorResponse

PATCH/api/onboarding Bearer token

Set the onboarding welcome message

Sets the markdown welcome message shown at the top of the onboarding page, or removes it with null or an empty string. Every onboarding page goes on to show where to start and ends with the help & support pages and the support address, with or without a message. Can be set while the page is off. Requires a superuser's access token.

Request body

application/jsonrequiredUpdateOnboardingSettingsRequest

Field	Type	Required	Description
welcome_markdown	string \| null	yes	The welcome message, as markdown; raw HTML is not rendered. Send null or an empty string to remove it. at most 50000 characters

Field

Type

Required

Description

welcome_markdown

string | null

yes

The welcome message, as markdown; raw HTML is not rendered. Send null or an empty string to remove it.

at most 50000 characters

Responses

Status	Description	Body
200	The updated onboarding settings.	OnboardingSettings
400	The request body failed validation.	ErrorResponse
401	The access token is missing or invalid.	ErrorResponse
403	The access token's subject is not a superuser.	ErrorResponse
500	The onboarding settings could not be written to.	ErrorResponse