Skip to main content
Version: Next

RESTPostAPIGuildsJSONBody

https://discord.com/developers/docs/resources/guild#create-guild

Index

Properties

Properties

optionalafk_channel_id

afk_channel_id?: null | string | number

ID for afk channel

optionalafk_timeout

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

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

optionalchannels

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

optionaldefault_message_notifications

default_message_notifications?: GuildDefaultMessageNotifications

Default message notification level

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

optionalexplicit_content_filter

explicit_content_filter?: GuildExplicitContentFilter

Explicit content filter level

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

optionalicon

icon?: string

base64 1024x1024 png/jpeg image for the guild icon

See https://discord.com/developers/docs/reference#image-data

name

name: string

Name of the guild (2-100 characters)

optionalpremium_progress_bar_enabled

premium_progress_bar_enabled?: boolean

Whether the boosts progress bar should be enabled.

optionalregion

region?: string

Voice region id

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

optionalroles

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

optionalsystem_channel_flags

system_channel_flags?: GuildSystemChannelFlags

System channel flags

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

optionalsystem_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

optionalverification_level

verification_level?: GuildVerificationLevel

Verification level

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