Discord icon

Discord

Interact with Discord API - users, messages, webhooks, guilds, interactions, and more

Actions193

Guild → Begin Prune

AI-generated

Summary

Start a prune for inactive members in a Discord guild. Choose whether to compute the pruned-member count, and optionally limit pruning by days, include specific roles, and record a reason.

Inputs

  • Guild (required) — Discord guild snowflake ID to prune.
  • Days — Number of days for the prune, from 1 to 30. Leave empty to use Discord's default.
  • Compute Prune Count — Defaults to true; controls whether Discord returns the number of members that will be pruned. The UI discourages enabling this for large guilds.
  • Include Roles — Comma-separated role snowflake IDs to include in the prune.
  • Reason — Reason included in the prune request body.
  • Audit Log Reason — Reason recorded in the guild audit log; Discord limits this header to 512 characters.
  • Authentication — Defaults to Bot Token; the UI also offers OAuth2 (User Token).

Output shape

A single Discord API response item.

The operation starts the prune; the response may include the pruned-member count depending on Compute Prune Count. Request options can also configure batching, SSL certificate handling, proxy, and timeout.

Links

Discussion