Interface APIGuildOnboardingPrompt

interface APIGuildOnboardingPrompt {
    id: string;
    in_onboarding: boolean;
    options: APIGuildOnboardingPromptOption[];
    required: boolean;
    single_select: boolean;
    title: string;
    type: GuildOnboardingPromptType;
}

Properties

id: string

Id of the prompt

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

Options available within the prompt

required: boolean

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

single_select: boolean

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

title: string

Title of the prompt

Type of prompt