Interface RESTAPIGuildOnboardingPrompt

interface RESTAPIGuildOnboardingPrompt {
    id: string;
    in_onboarding?: _AddUndefinedToPossiblyUndefinedPropertiesOfInterface<
        undefined
        | boolean,
    >;
    options: RESTAPIGuildOnboardingPromptOption[];
    required?: _AddUndefinedToPossiblyUndefinedPropertiesOfInterface<
        undefined
        | boolean,
    >;
    single_select?: _AddUndefinedToPossiblyUndefinedPropertiesOfInterface<
        undefined
        | boolean,
    >;
    title: string;
    type?: _AddUndefinedToPossiblyUndefinedPropertiesOfInterface;
}

Hierarchy (View Summary)

_AddUndefinedToPossiblyUndefinedPropertiesOfInterface<
    Partial<
        Omit<APIGuildOnboardingPrompt, "guild_id" | "id" | "options" | "title">,
    >,
>
Pick<APIGuildOnboardingPrompt, "id" | "title">
- RESTAPIGuildOnboardingPrompt

Index

Properties

id in_onboarding? options required? single_select? title type?

Properties

id

id: string

Id of the prompt

`Optional`in_onboarding

in_onboarding?: _AddUndefinedToPossiblyUndefinedPropertiesOfInterface<
undefined
| boolean,
>

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

options

options: RESTAPIGuildOnboardingPromptOption[]

Options available within the prompt

`Optional`required

required?: _AddUndefinedToPossiblyUndefinedPropertiesOfInterface<
undefined
| boolean,
>

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

`Optional`single_select

single_select?: _AddUndefinedToPossiblyUndefinedPropertiesOfInterface<
undefined
| boolean,
>

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

title

title: string

Title of the prompt

`Optional`type

type?: _AddUndefinedToPossiblyUndefinedPropertiesOfInterface

Type of prompt