Skip to content

Update invite docs #7779

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

Merged
advaith1 merged 2 commits into from
Sep 8, 2025
Merged

Update invite docs #7779

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
55abb89
Update invite docs
advaith1 Aug 25, 2025
0639809
remove from stage instance file
advaith1 Aug 25, 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
1 change: 1 addition & 0 deletions docs/events/gateway-events.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -977,6 +977,7 @@ Sent when a new invite to a channel is created.
| target_application? | partial [application](/docs/resources/application#application-object) object | Embedded application to open for this voice channel embedded application invite |
| temporary | boolean | Whether or not the invite is temporary (invited users will be kicked on disconnect unless they're assigned a role) |
| uses | integer | How many times the invite has been used (always will be 0) |
| expires_at | ?ISO8601 timestamp | the expiration date of this invite |

#### Invite Delete

Expand Down
31 changes: 15 additions & 16 deletions docs/resources/invite.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,22 +10,21 @@ 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 |
| stage_instance? | [invite stage instance](/docs/resources/invite#invite-stage-instance-object) object | stage instance data if there is a [public Stage instance](/docs/resources/stage-instance) in the Stage channel this invite is for (deprecated) |
| 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 |
| 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
1 change: 0 additions & 1 deletion docs/resources/stage-instance.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,6 @@ Below are some definitions related to stages.
- **Topic**: This is the blurb that gets shown below the channel's name, among other places.
- **Public**: A Stage instance is public when it has a `privacy_level` of `PUBLIC`. While a guild has a public Stage instance:
- Users in the Stage can have the Stage show in their [activities](/docs/events/gateway-events#presence).
- [Invites](/docs/resources/invite#invite-object) to the Stage channel will have the `stage_instance` field.

## Auto Closing

Expand Down