Skip to main content
Module

x/discord_api_types/v8.ts>RESTPostAPIGuildsJSONBody

Up to date Discord API Typings, versioned by the API version
Go to Latest
interface RESTPostAPIGuildsJSONBody
Re-export
Deprecated
Deprecated

API and gateway v8 are deprecated and the types will not receive further updates, please update to v10.

import { type RESTPostAPIGuildsJSONBody } from "https://deno.land/x/discord_api_types@0.37.40/v8.ts";

Properties

name: string

Name of the guild (2-100 characters)

optional
region: string | undefined
optional
icon: string | undefined

base64 1024x1024 png/jpeg image for the guild icon

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

optional
default_message_notifications: GuildDefaultMessageNotifications | undefined
optional
explicit_content_filter: GuildExplicitContentFilter | undefined
optional
roles: APIGuildCreateRole[] | undefined

New guild roles

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.

When using this parameter, 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

optional
channels: APIGuildCreatePartialChannel[] | undefined

New guild's channels

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

When using the channels parameter, 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

optional
afk_channel_id:
| number
| null
| undefined

ID for afk channel

optional
afk_timeout: number | undefined

AFK timeout in seconds

optional
system_channel_id:
| number
| null
| undefined

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

optional
premium_progress_bar_enabled: boolean | undefined

Whether the boosts progress bar should be enabled.