Interface EditGuildOptions

interface EditGuildOptions {
    afkChannelID?: null | string;
    afkTimeout?: number;
    banner?: null | string | Buffer;
    defaultMessageNotifications?: DefaultMessageNotificationLevels;
    description?: null | string;
    discoverySplash?: null | string | Buffer;
    explicitContentFilter?: ExplicitContentFilterLevels;
    features?: ("ACTIVITIES_ALPHA" | "ACTIVITIES_EMPLOYEE" | "ACTIVITIES_INTERNAL_DEV" | "ANIMATED_BANNER" | "ANIMATED_ICON" | "APPLICATION_COMMAND_PERMISSIONS_V2" | "AUTO_MODERATION" | "AUTOMOD_TRIGGER_USER_PROFILE" | "BANNER" | "BOT_DEVELOPER_EARLY_ACCESS" | "BURST_REACTIONS" | "CHANNEL_HIGHLIGHTS_DISABLED" | "CHANNEL_HIGHLIGHTS" | "CHANNEL_ICON_EMOJIS_GENERATED" | "CLYDE_DISABLED" | "CLYDE_ENABLED" | "CLYDE_EXPERIMENT_ENABLED" | "COMMERCE" | "COMMUNITY_CANARY" | "COMMUNITY_EXP_LARGE_GATED" | "COMMUNITY_EXP_LARGE_UNGATED" | "COMMUNITY_EXP_MEDIUM" | "COMMUNITY" | "CREATOR_ACCEPTED_NEW_TERMS" | "CREATOR_MONETIZABLE_DISABLED" | "CREATOR_MONETIZABLE_PENDING_NEW_OWNER_ONBOARDING" | "CREATOR_MONETIZABLE_PROVISIONAL" | "CREATOR_MONETIZABLE_RESTRICTED" | "CREATOR_MONETIZABLE_WHITEGLOVE" | "CREATOR_MONETIZABLE" | "CREATOR_STORE_PAGE" | "DEVELOPER_SUPPORT_SERVER" | "DISCOVERABLE_DISABLED" | "DISCOVERABLE" | "ENABLED_DISCOVERABLE_BEFORE" | "ENABLED_MODERATION_EXPERIENCE_FOR_NON_COMMUNITY" | "EXPOSED_TO_ACTIVITIES_WTP_EXPERIMENT" | "FEATURABLE" | "GUESTS_ENABLED" | "GUILD_HOME_DEPRECATION_OVERRIDE" | "GUILD_HOME_OVERRIDE" | "GUILD_HOME_TEST" | "GUILD_ONBOARDING_EVER_ENABLED" | "GUILD_ONBOARDING_HAS_PROMPTS" | "GUILD_ONBOARDING" | "GUILD_ROLE_SUBSCRIPTION_TIER_TEMPLATE" | "GUILD_SERVER_GUIDE" | "GUILD_WEB_PAGE_VANITY_URL" | "HAD_EARLY_ACTIVITIES_ACCESS" | "HAS_DIRECTORY_ENTRY" | "HUB" | "INCREASED_THREAD_LIMIT" | "INTERNAL_EMPLOYEE_ONLY" | "INVITE_SPLASH" | "INVITES_DISABLED" | "LINKED_TO_HUB" | "MARKETPLACES_CONNECTION_ROLES" | "MEMBER_PROFILES" | "MEMBER_SAFETY_PAGE_ROLLOUT" | "MEMBER_VERIFICATION_GATE_ENABLED" | "MONETIZATION_ENABLED" | "MORE_EMOJI" | "MORE_EMOJIS" | "MORE_STICKERS" | "NEW_THREAD_PERMISSIONS" | "NEWS" | "NON_COMMUNITY_RAID_ALERTS" | "PARTNERED" | "PREVIEW_ENABLED" | "PREVIOUSLY_DISCOVERABLE" | "PRIVATE_THREADS" | "PRODUCTS_AVAILABLE_FOR_PURCHASE" | "RAID_ALERTS_DISABLED" | "RAID_ALERTS_ENABLED" | "ROLE_ICONS" | "ROLE_SUBSCRIPTIONS_AVAILABLE_FOR_PURCHASE" | "ROLE_SUBSCRIPTIONS_ENABLED" | "SEVEN_DAY_THREAD_ARCHIVE" | "SHARD" | "SOUNDBOARD" | "SUMMARIES_DISABLED_BY_USER" | "SUMMARIES_ENABLED_BY_USER" | "SUMMARIES_ENABLED_GA" | "SUMMARIES_ENABLED" | "SUMMARIES_OPT_OUT_EXPERIENCE" | "SUMMARIES_PAUSED" | "TEXT_IN_STAGE_ENABLED" | "TEXT_IN_VOICE_ENABLED" | "THREADS_ENABLED_TESTING" | "THREADS_ENABLED" | "THREE_DAY_THREAD_ARCHIVE" | "TICKETED_EVENTS_ENABLED" | "VANITY_URL" | "VERIFIED" | "VIP_REGIONS" | "VOICE_IN_THREADS" | "WELCOME_SCREEN_ENABLED")[];
    icon?: null | string | Buffer;
    name?: string;
    ownerID?: string;
    preferredLocale?: null | string;
    premiumProgressBarEnabled?: boolean;
    publicUpdatesChannelID?: null | string;
    reason?: string;
    region?: null | string;
    rulesChannelID?: null | string;
    safetyAlertsChannelID?: null | string;
    splash?: null | string | Buffer;
    systemChannelFlags?: number;
    systemChannelID?: null | string;
    verificationLevel?: VerificationLevels;
}

Properties

afkChannelID? afkTimeout? banner? defaultMessageNotifications? description? discoverySplash? explicitContentFilter? features? icon? name? ownerID? preferredLocale? premiumProgressBarEnabled? publicUpdatesChannelID? reason? region? rulesChannelID? safetyAlertsChannelID? splash? systemChannelFlags? systemChannelID? verificationLevel?

Properties

Optional afkChannelID

afkChannelID?: null | string

The ID of the AFK voice channel. null to reset.

Optional afkTimeout

afkTimeout?: number

The AFK timeout in seconds.

Optional banner

banner?: null | string | Buffer

The banner of the guild (buffer, or full data url). null to reset.

Optional defaultMessageNotifications

defaultMessageNotifications?: DefaultMessageNotificationLevels

The default message notification level.

Optional description

description?: null | string

The description of the guild. null to reset.

Optional discoverySplash

discoverySplash?: null | string | Buffer

The discovery splash of the guild (buffer, or full data url). null to reset.

Optional explicitContentFilter

explicitContentFilter?: ExplicitContentFilterLevels

The explicit content filter level.

Optional features

features?: ("ACTIVITIES_ALPHA" | "ACTIVITIES_EMPLOYEE" | "ACTIVITIES_INTERNAL_DEV" | "ANIMATED_BANNER" | "ANIMATED_ICON" | "APPLICATION_COMMAND_PERMISSIONS_V2" | "AUTO_MODERATION" | "AUTOMOD_TRIGGER_USER_PROFILE" | "BANNER" | "BOT_DEVELOPER_EARLY_ACCESS" | "BURST_REACTIONS" | "CHANNEL_HIGHLIGHTS_DISABLED" | "CHANNEL_HIGHLIGHTS" | "CHANNEL_ICON_EMOJIS_GENERATED" | "CLYDE_DISABLED" | "CLYDE_ENABLED" | "CLYDE_EXPERIMENT_ENABLED" | "COMMERCE" | "COMMUNITY_CANARY" | "COMMUNITY_EXP_LARGE_GATED" | "COMMUNITY_EXP_LARGE_UNGATED" | "COMMUNITY_EXP_MEDIUM" | "COMMUNITY" | "CREATOR_ACCEPTED_NEW_TERMS" | "CREATOR_MONETIZABLE_DISABLED" | "CREATOR_MONETIZABLE_PENDING_NEW_OWNER_ONBOARDING" | "CREATOR_MONETIZABLE_PROVISIONAL" | "CREATOR_MONETIZABLE_RESTRICTED" | "CREATOR_MONETIZABLE_WHITEGLOVE" | "CREATOR_MONETIZABLE" | "CREATOR_STORE_PAGE" | "DEVELOPER_SUPPORT_SERVER" | "DISCOVERABLE_DISABLED" | "DISCOVERABLE" | "ENABLED_DISCOVERABLE_BEFORE" | "ENABLED_MODERATION_EXPERIENCE_FOR_NON_COMMUNITY" | "EXPOSED_TO_ACTIVITIES_WTP_EXPERIMENT" | "FEATURABLE" | "GUESTS_ENABLED" | "GUILD_HOME_DEPRECATION_OVERRIDE" | "GUILD_HOME_OVERRIDE" | "GUILD_HOME_TEST" | "GUILD_ONBOARDING_EVER_ENABLED" | "GUILD_ONBOARDING_HAS_PROMPTS" | "GUILD_ONBOARDING" | "GUILD_ROLE_SUBSCRIPTION_TIER_TEMPLATE" | "GUILD_SERVER_GUIDE" | "GUILD_WEB_PAGE_VANITY_URL" | "HAD_EARLY_ACTIVITIES_ACCESS" | "HAS_DIRECTORY_ENTRY" | "HUB" | "INCREASED_THREAD_LIMIT" | "INTERNAL_EMPLOYEE_ONLY" | "INVITE_SPLASH" | "INVITES_DISABLED" | "LINKED_TO_HUB" | "MARKETPLACES_CONNECTION_ROLES" | "MEMBER_PROFILES" | "MEMBER_SAFETY_PAGE_ROLLOUT" | "MEMBER_VERIFICATION_GATE_ENABLED" | "MONETIZATION_ENABLED" | "MORE_EMOJI" | "MORE_EMOJIS" | "MORE_STICKERS" | "NEW_THREAD_PERMISSIONS" | "NEWS" | "NON_COMMUNITY_RAID_ALERTS" | "PARTNERED" | "PREVIEW_ENABLED" | "PREVIOUSLY_DISCOVERABLE" | "PRIVATE_THREADS" | "PRODUCTS_AVAILABLE_FOR_PURCHASE" | "RAID_ALERTS_DISABLED" | "RAID_ALERTS_ENABLED" | "ROLE_ICONS" | "ROLE_SUBSCRIPTIONS_AVAILABLE_FOR_PURCHASE" | "ROLE_SUBSCRIPTIONS_ENABLED" | "SEVEN_DAY_THREAD_ARCHIVE" | "SHARD" | "SOUNDBOARD" | "SUMMARIES_DISABLED_BY_USER" | "SUMMARIES_ENABLED_BY_USER" | "SUMMARIES_ENABLED_GA" | "SUMMARIES_ENABLED" | "SUMMARIES_OPT_OUT_EXPERIENCE" | "SUMMARIES_PAUSED" | "TEXT_IN_STAGE_ENABLED" | "TEXT_IN_VOICE_ENABLED" | "THREADS_ENABLED_TESTING" | "THREADS_ENABLED" | "THREE_DAY_THREAD_ARCHIVE" | "TICKETED_EVENTS_ENABLED" | "VANITY_URL" | "VERIFIED" | "VIP_REGIONS" | "VOICE_IN_THREADS" | "WELCOME_SCREEN_ENABLED")[]

The features of the guild. Only some can be added or removed.

Optional icon

icon?: null | string | Buffer

The icon of the guild (buffer or full data url). null to reset.

Optional name

name?: string

The name of the guild.

Optional ownerID

ownerID?: string

The ID of the member to transfer guild ownership to.

Optional preferredLocale

preferredLocale?: null | string

The preferred locale of the guild. null to reset.

Optional premiumProgressBarEnabled

premiumProgressBarEnabled?: boolean

If the premium progress bar is enabled.

Optional publicUpdatesChannelID

publicUpdatesChannelID?: null | string

The ID of the public updates channel. null to reset, or 1 to create a new channel.

Optional reason

reason?: string

The reason for editing the guild.

Optional region

region?: null | string

Deprecated

The region of the guild.

Optional rulesChannelID

rulesChannelID?: null | string

The ID of the rules channel. null to reset, or 1 to create a new channel.

Optional safetyAlertsChannelID

safetyAlertsChannelID?: null | string

The ID of the channel where safety alert are received. null to reset, or 1 to create a new channel.

Optional splash

splash?: null | string | Buffer

The splash of the guild (buffer, or full data url). null to reset.

Optional systemChannelFlags

systemChannelFlags?: number

The system channel flags.

Optional systemChannelID

systemChannelID?: null | string

The ID of the system channel. null to reset.

Optional verificationLevel

verificationLevel?: VerificationLevels

The verification level of the guild.

Settings

Member Visibility

Theme

On This Page

afkChannelIDafkTimeoutbannerdefaultMessageNotificationsdescriptiondiscoverySplashexplicitContentFilterfeaturesiconnameownerIDpreferredLocalepremiumProgressBarEnabledpublicUpdatesChannelIDreasonregionrulesChannelIDsafetyAlertsChannelIDsplashsystemChannelFlagssystemChannelIDverificationLevel