Skip to content

Document Prune Requires Admin guild feature #8540

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
advaith1 wants to merge 1 commit into
base: main
Choose a base branch
from
+20 −7
Open

Document Prune Requires Admin guild feature #8540

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions developers/change-log.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,18 @@ rss: true

import {Route} from '/snippets/route.jsx'

<Update label="August 12, 2026" tags={["HTTP API", "Breaking Change"]} rss={{
title: "PRUNE_REQUIRES_ADMIN Guild Feature",
description: "Prune endpoints require the ADMINISTRATOR permission if the guild has the new PRUNE_REQUIRES_ADMIN guild feature."
}}>

## `PRUNE_REQUIRES_ADMIN` Guild Feature

The [Get Guild Prune Count](/developers/resources/guild#get-guild-prune-count) and [Begin Guild Prune](/developers/resources/guild#begin-guild-prune) endpoints require the `ADMINISTRATOR` permission if the guild has the new `PRUNE_REQUIRES_ADMIN` guild feature, which can be enabled by the server owner.

Without this guild feature, the endpoints still require the `MANAGE_GUILD` and `KICK_MEMBERS` permissions.
</Update>

<Update label="August 11, 2026" tags={["Discord Social SDK"]} rss={{
title: "Discord Social SDK Hotfixes 1.10.18369, 1.9.18337 & 1.8.18335",
description: "Hotfix releases across the 1.8, 1.9, and 1.10 branches fixing C# bool marshaling and a PlayStation 5 lobby dispatch crash."
Expand Down Expand Up @@ -2755,10 +2767,10 @@ A new release of the Discord Social SDK is now available, with the following upd
</Update>

<Update label="March 15, 2024" tags={["Breaking Changes"]} rss={{
title: "Guild Prune Requiring",
title: "Guild Prune Requiring MANAGE_GUILD",
description: "The Get Guild Prune Count and Begin Guild Prune endpoints now require the MANAGE_GUILD permission alongside the existing KICK_MEMBERS requirement."
}}>
## Guild Prune Requiring
## Guild Prune Requiring `MANAGE_GUILD`

The [Get Guild Prune Count](/developers/resources/guild#get-guild-prune-count) and [Begin Guild Prune](/developers/resources/guild#begin-guild-prune)
endpoints now require the `MANAGE_GUILD` permission alongside the existing `KICK_MEMBERS` requirement.
Expand Down
11 changes: 6 additions & 5 deletions developers/resources/guild.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,10 @@ Fields specific to the `GUILD_CREATE` event are listed in the [Gateway Events do
| CREATOR_STORE_PAGE | guild has enabled the role subscription promo page |
| DEVELOPER_SUPPORT_SERVER | guild has been set as a support server on the App Directory |
| DISCOVERABLE | guild is able to be discovered in the directory |
| ENHANCED_ROLE_COLORS | guild is able to set gradient colors to roles |
| FEATURABLE | guild is able to be featured in the directory |
| GUILD_TAGS | guild has access to set guild tags |
| GUESTS_ENABLED | guild has access to guest invites |
| INVITES_DISABLED | guild has paused invites, preventing new users from joining |
| INVITE_SPLASH | guild has access to set an invite splash background |
| MEMBER_VERIFICATION_GATE_ENABLED | guild has enabled [Membership Screening](/developers/resources/guild#membership-screening-object) |
Expand All @@ -160,6 +163,7 @@ Fields specific to the `GUILD_CREATE` event are listed in the [Gateway Events do
| NEWS | guild has access to create announcement channels |
| PARTNERED | guild is partnered |
| PREVIEW_ENABLED | guild can be previewed before joining via Membership Screening or the directory |
| PRUNE_REQUIRES_ADMIN | guild has enabled requiring admin to prune members |
| RAID_ALERTS_DISABLED | guild has disabled alerts for join raids in the configured safety alerts channel |
| ROLE_ICONS | guild is able to set role icons |
| ROLE_SUBSCRIPTIONS_AVAILABLE_FOR_PURCHASE | guild has role subscriptions that can be purchased |
Expand All @@ -170,9 +174,6 @@ Fields specific to the `GUILD_CREATE` event are listed in the [Gateway Events do
| VERIFIED | guild is verified |
| VIP_REGIONS | guild has access to set 384kbps bitrate in voice (previously VIP voice servers) |
| WELCOME_SCREEN_ENABLED | guild has enabled the welcome screen |
| GUESTS_ENABLED | guild has access to guest invites |
| GUILD_TAGS | guild has access to set guild tags |
| ENHANCED_ROLE_COLORS | guild is able to set gradient colors to roles |

<ManualAnchor id="guild-object-mutable-guild-features" />
###### Mutable Guild Features
Expand Down Expand Up @@ -1323,7 +1324,7 @@ This endpoint supports the `X-Audit-Log-Reason` header.
## Get Guild Prune Count
<Route method="GET">/guilds/[\{guild.id\}](/developers/resources/guild#guild-object)/prune</Route>

Returns an object with one `pruned` key indicating the number of members that would be removed in a prune operation. Requires the `MANAGE_GUILD` and `KICK_MEMBERS` permissions.
Returns an object with one `pruned` key indicating the number of members that would be removed in a prune operation. Requires the `MANAGE_GUILD` and `KICK_MEMBERS` permissions, unless the guild has the `PRUNE_REQUIRES_ADMIN` guild feature, in which case it requires the `ADMINISTRATOR` permission.

By default, prune will not remove users with roles. You can optionally include specific roles in your prune by providing the `include_roles` parameter. Any inactive user that has a subset of the provided role(s) will be counted in the prune and users with additional roles will not.

Expand All @@ -1338,7 +1339,7 @@ By default, prune will not remove users with roles. You can optionally include s
## Begin Guild Prune
<Route method="POST">/guilds/[\{guild.id\}](/developers/resources/guild#guild-object)/prune</Route>

Begin a prune operation. Requires the `MANAGE_GUILD` and `KICK_MEMBERS` permissions. Returns an object with one `pruned` key indicating the number of members that were removed in the prune operation. For large guilds it's recommended to set the `compute_prune_count` option to `false`, forcing `pruned` to `null`. Fires multiple [Guild Member Remove](/developers/events/gateway-events#guild-member-remove) Gateway events.
Begin a prune operation. Requires the `MANAGE_GUILD` and `KICK_MEMBERS` permissions, unless the guild has the `PRUNE_REQUIRES_ADMIN` guild feature, in which case it requires the `ADMINISTRATOR` permission. Returns an object with one `pruned` key indicating the number of members that were removed in the prune operation. For large guilds it's recommended to set the `compute_prune_count` option to `false`, forcing `pruned` to `null`. Fires multiple [Guild Member Remove](/developers/events/gateway-events#guild-member-remove) Gateway events.

By default, prune will not remove users with roles. You can optionally include specific roles in your prune by providing the `include_roles` parameter. Any inactive user that has a subset of the provided role(s) will be included in the prune and users with additional roles will not.

Expand Down