/prune

Prunes x amount of members from the provided guild

This endpoint requires a POST request!

Endpoint Headers:

• bot-token - Token of the Bot [String] (Required)

• guild-id - ID of the guild to be fetched [Snowflake] (Required)

• apikey - Your Api Auth Key [String] (Required)

Endpoint Body Parameters:

• days - number of days to prune (1-30) [Integer] (Optional)

• count - whether pruned is returned, discouraged for large guilds [Boolean] (Optional)

• roles - role(s) to include [Array of Snowflakes] (Optional)

• reason - reason for the prune [String] (Optional)

Examples:

Data API version required. Must replace <version> with either release or beta.

Bot Designer for Discord

Example usage of /guild/prune endpoint using BDFD

$httpAddHeader[apikey;<YOUR-API-KEY>]
$httpAddHeader[bot-token;<YOUR-BOT-TOKEN>]
$httpAddHeader[guild-id;1064098700307218463] 
$httpPost[https://bdfddata.rickyjs.xyz/<version>/guild/prune;{
days: 30,
reason: 'They dead lolz'
}]


$httpResult OR $httpResult[details]

Discord.js

Example usage of /guild/prune endpoint using Discord.js

const axios = require('axios');
(async () => {
return await axios.post('https://bdfddata.rickyjs.xyz/<version>/guild/prune', {
days: 30,
reason: 'They dead lolz'
}, {
headers: {
'apikey': <YOUR-API-KEY>,
'bot-token': <YOUR-BOT-TOKEN>,
'guild-id': '1064098700307218463',
}
}).then(res=>res.data)
})()

Possible Responses (Codes)

Code 200

API succeeded and details were fetched.

{
 status: 200,
 details: {pruned: x } // 'x' is replaced with the number of pruned members IF count is true
 }   

Code 400

An error occurred that stopped execution.

{
    status: 400
    error: 'Cannot read ...  (This can vary)'
}

Code 401

Invalid bot token was provided.

{
  status: 401,
  details: { message: '401: Unauthorized', code: 0 }
}