Skip to content

with-permissions query #7768

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 8 commits into from
+21 −19
Closed

with-permissions query #7768

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
f52afdd
Add `with_permissions` query and `is_nickname_changeable` field
Sacul0457 Aug 20, 2025
9bd3af1
change wording
Sacul0457 Aug 20, 2025
8b901d2
Update invite.mdx
Sacul0457 Aug 20, 2025
b360c47
Update invite.mdx
Sacul0457 Aug 20, 2025
1f92cc9
revert the change, will fix it later on
Sacul0457 Aug 20, 2025
7d69b59
fixed the table
Sacul0457 Aug 21, 2025
7a8d800
Update invite.mdx
Sacul0457 Aug 21, 2025
6ff2123
Merge branch 'main' into with_permissions-param
Sacul0457 Sep 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 21 additions & 19 deletions docs/resources/invite.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,22 @@ Represents a code that when used, adds a user to a guild or group DM channel.

###### Invite Structure

| Field | Type | Description |
|-----------------------------|----------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------|
| type | integer | the [type of invite](/docs/resources/invite#invite-object-invite-types) |
| code | string | the invite code (unique ID) |
| guild? | partial [guild](/docs/resources/guild#guild-object) object | the guild this invite is for |
| channel | ?partial [channel](/docs/resources/channel#channel-object) object | the channel this invite is for |
| inviter? | [user](/docs/resources/user#user-object) object | the user who created the invite |
| target_type? | integer | the [type of target](/docs/resources/invite#invite-object-invite-target-types) for this voice channel invite |
| target_user? | [user](/docs/resources/user#user-object) object | the user whose stream to display for this voice channel stream invite |
| target_application? | partial [application](/docs/resources/application#application-object) object | the embedded application to open for this voice channel embedded application invite |
| approximate_presence_count? | integer | approximate count of online members, returned from the `GET /invites/<code>` endpoint when `with_counts` is `true` |
| approximate_member_count? | integer | approximate count of total members, returned from the `GET /invites/<code>` endpoint when `with_counts` is `true` |
| expires_at | ?ISO8601 timestamp | the expiration date of this invite |
| guild_scheduled_event? | [guild scheduled event](/docs/resources/guild-scheduled-event#guild-scheduled-event-object) object | guild scheduled event data, only included if `guild_scheduled_event_id` contains a valid guild scheduled event id |
| flags? | integer | [guild invite flags](/docs/resources/invite#invite-object-guild-invite-flags) for guild invites |
| Field | Type | Description |
|-----------------------------|----------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
| type | integer | the [type of invite](/docs/resources/invite#invite-object-invite-types) |
| code | string | the invite code (unique ID) |
| guild? | partial [guild](/docs/resources/guild#guild-object) object | the guild this invite is for |
| channel | ?partial [channel](/docs/resources/channel#channel-object) object | the channel this invite is for |
| inviter? | [user](/docs/resources/user#user-object) object | the user who created the invite |
| is_nickname_changeable? | [boolean](/docs/reference#boolean-query-strings) | a member's ability to change their nickname by default, returned from the `GET /invites/<code>` endpoint when `with_permissions` is `true` |
| target_type? | integer | the [type of target](/docs/resources/invite#invite-object-invite-target-types) for this voice channel invite |
| target_user? | [user](/docs/resources/user#user-object) object | the user whose stream to display for this voice channel stream invite |
| target_application? | partial [application](/docs/resources/application#application-object) object | the embedded application to open for this voice channel embedded application invite |
| approximate_presence_count? | integer | approximate count of online members, returned from the `GET /invites/<code>` endpoint when `with_counts` is `true` |
| approximate_member_count? | integer | approximate count of total members, returned from the `GET /invites/<code>` endpoint when `with_counts` is `true` |
| expires_at | ?ISO8601 timestamp | the expiration date of this invite |
| guild_scheduled_event? | [guild scheduled event](/docs/resources/guild-scheduled-event#guild-scheduled-event-object) object | guild scheduled event data, only included if `guild_scheduled_event_id` contains a valid guild scheduled event id |
| flags? | integer | [guild invite flags](/docs/resources/invite#invite-object-guild-invite-flags) for guild invites |

###### Invite Types

Expand Down Expand Up @@ -158,10 +159,11 @@ Returns an [invite](/docs/resources/invite#invite-object) object for the given c

###### Query String Params

| Field | Type | Description |
|---------------------------|--------------------------------------------------|-------------------------------------------------------------|
| with_counts? | [boolean](/docs/reference#boolean-query-strings) | whether the invite should contain approximate member counts |
| guild_scheduled_event_id? | snowflake | the guild scheduled event to include with the invite |
| Field | Type | Description |
|---------------------------|--------------------------------------------------|----------------------------------------------------------------------|
| with_counts? | [boolean](/docs/reference#boolean-query-strings) | whether the invite should contain approximate member counts |
| guild_scheduled_event_id? | snowflake | the guild scheduled event to include with the invite |
| with_permissions? | [boolean](/docs/reference#boolean-query-strings) | whether the invite should contain the `is_nickname_changeable` field |

## Delete Invite
<Route method="DELETE">/invites/[\{invite.code\}](/docs/resources/invite#invite-object)</Route>
Expand Down