guild_begin_prune
guild_begin_prune
Section titled “guild_begin_prune”Category: guild
Kick inactive members. DESTRUCTIVE — kicked members must rejoin manually.
When to use
Section titled “When to use”- Reduce inactive bloat in large communities.
compute_prune_count (default true) returns the actual count; set false for large guilds (returns null) to avoid timeouts.
When NOT to use
Section titled “When NOT to use”| Field | Type | Required | Description |
|---|---|---|---|
guild_id | string | yes | Guild to prune |
days | integer | no | Inactivity threshold in days (1..30, default 7) |
compute_prune_count | boolean | no | Whether to return prune count (default true; set false for large guilds) |
include_roles | array | no | Members must have ALL these roles to be eligible |
audit_reason | string | no | Reason recorded in audit log (X-Audit-Log-Reason header) |
Returns
Section titled “Returns”\{pruned, guild_id\} — pruned is null if compute_prune_count was false.
Output schema
Section titled “Output schema”| Field | Type | Required | Description |
|---|---|---|---|
pruned | unknown | yes | |
guild_id | string | yes | Discord guild (server) ID |
Annotations
Section titled “Annotations”| Property | Value |
|---|---|
| Read-only | no |
| Destructive | yes |
| Idempotent | no |
| Open-world | yes |
| Confirmation required | yes (__confirm:true required) |