Skip to main content

EditGuildOnboarding

@discordeno/bot

Documentation / @discordeno/bot / EditGuildOnboarding

Interface: EditGuildOnboarding

Defined in: packages/types/dist/types/discordeno.d.ts:1306

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

Properties​

defaultChannelIds​

defaultChannelIds: BigString[]

Defined in: packages/types/dist/types/discordeno.d.ts:1310

Channel IDs that members get opted into automatically

enabled​

enabled: boolean

Defined in: packages/types/dist/types/discordeno.d.ts:1312

Whether onboarding is enabled in the guild

mode​

mode: DiscordGuildOnboardingMode

Defined in: packages/types/dist/types/discordeno.d.ts:1314

Current mode of onboarding

prompts​

prompts: object[]

Defined in: packages/types/dist/types/discordeno.d.ts:1308

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