Skip to content

Commit

Permalink
reason param clarifications (#2830)
Browse files Browse the repository at this point in the history
  • Loading branch information
apacheli committed Apr 29, 2021
1 parent 6cd86c2 commit eed6084
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/resources/Guild.md
Original file line number Diff line number Diff line change
Expand Up @@ -766,6 +766,9 @@ Returns a [ban](#DOCS_RESOURCES_GUILD/ban-object) object for the given user or a

Create a guild ban, and optionally delete previous messages sent by the banned user. Requires the `BAN_MEMBERS` permission. Returns a 204 empty response on success. Fires a [Guild Ban Add](#DOCS_TOPICS_GATEWAY/guild-ban-add) Gateway event.

> info
> Supplying a reason in the JSON body will override `X-Audit-Log-Reason` header if both are provided.
###### JSON Params

| Field | Type | Description |
Expand Down Expand Up @@ -848,13 +851,17 @@ Begin a prune operation. Requires the `KICK_MEMBERS` permission. Returns an obje

By default, prune will not remove users with roles. You can optionally include specific roles in your prune by providing the `include_roles` parameter. Any inactive user that has a subset of the provided role(s) will be included in the prune and users with additional roles will not.

> info
> Supplying a reason in the JSON body will override `X-Audit-Log-Reason` header if both are provided.
###### JSON Params

| Field | Type | Description | Default |
| ------------------- | ------------------- | ---------------------------------------------------------- | ------- |
| days | integer | number of days to prune (1-30) | 7 |
| compute_prune_count | boolean | whether 'pruned' is returned, discouraged for large guilds | true |
| include_roles | array of snowflakes | role(s) to include | none |
| reason? | string | reason for the prune | |

## Get Guild Voice Regions % GET /guilds/{guild.id#DOCS_RESOURCES_GUILD/guild-object}/regions

Expand Down

0 comments on commit eed6084

Please sign in to comment.