title: Begin Guild Prune category: Guild
beginGuildPrune
$client->guild->beginGuildPrune($parameters);
Begin a prune operation. Requires the 'KICK_MEMBERS' permission. Fires multiple Guild Member Remove Gateway events.
Name | Type | Required | Default |
---|---|---|---|
guild.id | snowflake | true | null |
days | integer | false | null |
Returns an object with one 'pruned' key indicating the number of members that were removed in the prune operation.