Version: Next

APITemplateSerializedSourceGuild

Hierarchy

Omit<RESTPostAPIGuildsJSONBody, icon>
- APITemplateSerializedSourceGuild

Index

Properties

afk_channel_id
afk_timeout
channels
default_message_notifications
description
explicit_content_filter
icon_hash
name
preferred_locale
premium_progress_bar_enabled
region
roles
system_channel_flags
system_channel_id
verification_level

Properties

optionalinheritedafk_channel_id

afk_channel_id?: null | string | number

ID for afk channel

optionalinheritedafk_timeout

afk_timeout?: 1800 | 3600 | 60 | 300 | 900

afk timeout in seconds, can be set to: 60, 300, 900, 1800, 3600

optionalinheritedchannels

channels?: RESTAPIGuildCreatePartialChannel[]

New guild's channels

@remarks: When using the channels parameter, the position field is ignored, and none of the default channels are created.

Also, the id field within each channel object may be set to an integer placeholder, and will be replaced by the API upon consumption. Its purpose is to allow you to create GUILD_CATEGORY channels by setting the parent_id field on any children to the category's id field. Category channels must be listed before any children.
@see: https://discord.com/developers/docs/resources/channel#channel-object

optionalinheriteddefault_message_notifications

default_message_notifications?: GuildDefaultMessageNotifications

Default message notification level

@see: https://discord.com/developers/docs/resources/guild#guild-object-default-message-notification-level

description

description: null | string

optionalinheritedexplicit_content_filter

explicit_content_filter?: GuildExplicitContentFilter

Explicit content filter level

@see: https://discord.com/developers/docs/resources/guild#guild-object-explicit-content-filter-level

icon_hash

icon_hash: null | string

inheritedname

name: string

Name of the guild (2-100 characters)

preferred_locale

preferred_locale: Locale

optionalinheritedpremium_progress_bar_enabled

premium_progress_bar_enabled?: boolean

Whether the boosts progress bar should be enabled.

optionalinheritedregion

region?: string

Voice region id

@see: https://discord.com/developers/docs/resources/voice#voice-region-object

optionalinheritedroles

roles?: RESTAPIGuildCreateRole[]

New guild roles

@remarks: When using this parameter, the first member of the array is used to change properties of the guild's @everyone role. If you are trying to bootstrap a guild with additional roles, keep this in mind.

Also, the required id field within each role object is an integer placeholder, and will be replaced by the API upon consumption. Its purpose is to allow you to overwrite a role's permissions in a channel when also passing in channels with the channels array.
@see: https://discord.com/developers/docs/topics/permissions#role-object

optionalinheritedsystem_channel_flags

system_channel_flags?: GuildSystemChannelFlags

System channel flags

@see: https://discord.com/developers/docs/resources/guild#guild-object-system-channel-flags

optionalinheritedsystem_channel_id

system_channel_id?: null | string | number

The id of the channel where guild notices such as welcome messages and boost events are posted

optionalinheritedverification_level

verification_level?: GuildVerificationLevel

Verification level

@see: https://discord.com/developers/docs/resources/guild#guild-object-verification-level