Preview environment

interface GuildOnboardingEditOptions

export interface GuildOnboardingEditOptions

Options used to edit the guild onboarding.

optional
defaultChannels? : readonly ChannelResolvable[] | ReadonlyCollection<Snowflake, GuildChannel>

The channels that new members get opted into automatically

optional
enabled? : boolean

Whether the onboarding is enabled

optional
mode? : GuildOnboardingMode

The mode to edit the guild onboarding with

The prompts shown during onboarding and in customize community

optional
reason? : string

The reason for editing the guild onboarding