Interface APIGuildOnboarding

See

https://discord.com/developers/docs/resources/guild#guild-onboarding-object-guild-onboarding-structure

interface APIGuildOnboarding {
    default_channel_ids: string[];
    enabled: boolean;
    guild_id: string;
    mode: GuildOnboardingMode;
    prompts: APIGuildOnboardingPrompt[];
}

Index

Properties

default_channel_ids enabled guild_id mode prompts

Properties

default_channel_ids

default_channel_ids: string[]

Channel ids that members get opted into automatically

enabled

enabled: boolean

Whether onboarding is enabled in the guild

guild_id

guild_id: string

Id of the guild this onboarding is part of

mode

mode: GuildOnboardingMode

Current mode of onboarding

prompts

prompts: APIGuildOnboardingPrompt[]

Prompts shown during onboarding and in customize community