Skip to main content
Module

x/harmony/mod.ts>RESTEndpoints#beginGuildPrune

An easy to use Discord API Library for Deno.
Go to Latest
method RESTEndpoints.prototype.beginGuildPrune
Re-export
import { RESTEndpoints } from "https://deno.land/x/harmony@v2.9.0/mod.ts";

Begin a prune operation. Requires the KICK_MEMBERS 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 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.

Parameters

guildId: string

Returns

Promise<void>