diff --git a/docs/resources/invite.mdx b/docs/resources/invite.mdx index 333c1f3e03..b5e41680a1 100644 --- a/docs/resources/invite.mdx +++ b/docs/resources/invite.mdx @@ -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/` endpoint when `with_counts` is `true` | -| approximate_member_count? | integer | approximate count of total members, returned from the `GET /invites/` 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/` 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/` endpoint when `with_counts` is `true` | +| approximate_member_count? | integer | approximate count of total members, returned from the `GET /invites/` 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 @@ -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 /invites/[\{invite.code\}](/docs/resources/invite#invite-object)