Skip to content

RESTAPIModifyGuildOnboardingPromptData

Signature

export type RESTAPIModifyGuildOnboardingPromptData = AddUndefinedToPossiblyUndefinedPropertiesOfInterface<Partial<Omit<APIGuildOnboardingPrompt, 'guild_id' | 'id' | 'options' | 'title'>>> & Pick<APIGuildOnboardingPrompt, 'id' | 'title'> & {    options: RESTAPIModifyGuildOnboardingPromptOptionData[];};

Properties

single_select: boolean;

Indicates whether users are limited to selecting one option for the prompt

required: boolean;

Indicates whether the prompt is required before a user completes the onboarding flow

in_onboarding: boolean;

Indicates whether the prompt is present in the onboarding flow. If `false`, the prompt will only appear in the Channels & Roles tab

title: string;

Title of the prompt