GuildOnboardingPrompt

interface GuildOnboardingPrompt

A question in the onboarding flow.

Properties

Property

Type

Description

id?

string

inOnboarding

boolean

Whether the prompt appears during onboarding, rather than only in Channels & Roles.

options

GuildOnboardingPromptOption[]

required

boolean

Whether members must answer before finishing onboarding.

singleSelect

boolean

Whether members can pick only one option.

title

string

type

0 | 1

0 for multiple choice, 1 for a dropdown.