interface GuildOnboardingPromptData

export interface GuildOnboardingPromptData

Data for editing a guild onboarding prompt.

optional
id? : Snowflake

The id of the prompt

optional
inOnboarding? : boolean

Whether the prompt is present in the onboarding flow

options : readonly GuildOnboardingPromptOptionData[] | ReadonlyCollection<Snowflake, GuildOnboardingPromptOption>

The options available within the prompt

optional
required? : boolean

Whether the prompt is required before a user completes the onboarding flow

optional
singleSelect? : boolean

Whether users are limited to selecting one option for the prompt

title : string

The title for the prompt

optional
type? : GuildOnboardingPromptType

The type of the prompt