RESTPostAPIGuildsJSONBody

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

seyfertlib/types/rest/guild.d.ts

Signature

export interface RESTPostAPIGuildsJSONBody
JSDoc
Deprecated

Properties

name
name: string;

Name of the guild (2-100 characters)

region
region?: string | undefined;

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

icon
icon?: string | undefined;

base64 1024x1024 png/jpeg image for the guild icon See https://discord.com/developers/docs/reference#image-data

roles
roles?: RESTAPIGuildCreateRole[] | undefined;

New guild roles

@remarksWhen 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
channels
channels?: RESTAPIGuildCreatePartialChannel[] | undefined;

New guild's channels

@remarksWhen 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
afk_timeout
afk_timeout?: 1800 | 3600 | 60 | 300 | 900 | undefined;

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

system_channel_id
system_channel_id?: Snowflake | number | null | undefined;

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