Skip to main content

EditGuildOnboarding

Documentation

Documentation / @discordeno/types / EditGuildOnboarding

Interface: EditGuildOnboarding

Defined in: discordeno/guild.ts:300

https://docs.discord.com/developers/resources/guild#modify-guild-onboarding-json-params

Properties​

defaultChannelIds?​

optional defaultChannelIds?: BigString[]

Defined in: discordeno/guild.ts:304

Channel IDs that members get opted into automatically

enabled?​

optional enabled?: boolean

Defined in: discordeno/guild.ts:306

Whether onboarding is enabled in the guild

mode?​

optional mode?: DiscordGuildOnboardingMode

Defined in: discordeno/guild.ts:308

Current mode of onboarding

prompts?​

optional prompts?: object[]

Defined in: discordeno/guild.ts:302

Prompts shown during onboarding and in customize community

id​

id: string

inOnboarding​

inOnboarding: boolean

options​

options: object[]

required​

required: boolean

singleSelect​

singleSelect: boolean

title​

title: string

type​

type: DiscordGuildOnboardingPromptType