beginGuildPrune
$client->guild->beginGuildPrune($parameters);
Description
Begin a prune operation. Requires the KICK_MEMBERS permission. 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.
Parameters
| Name | Type | Required | Default |
|---|---|---|---|
| guild.id | snowflake | true | null |
| days | integer | false | null |
| compute_prune_count | boolean | false | null |
Response
Returns an object with one 'pruned' key indicating the number of members that were removed in the prune operation.