Skip to content
Merged
Changes from all commits
Commits
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
10 changes: 10 additions & 0 deletions docs/resources/Invite.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Represents a code that when used, adds a user to a guild or group DM channel.

| 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 |
Expand All @@ -21,6 +22,14 @@ Represents a code that when used, adds a user to a guild or group DM channel.
| 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 |

###### Invite Types

| Type | Value |
|----------|-------|
| GUILD | 0 |
| GROUP_DM | 1 |
| FRIEND | 2 |

###### Invite Target Types

| Type | Value |
Expand All @@ -32,6 +41,7 @@ Represents a code that when used, adds a user to a guild or group DM channel.

```json
{
"type": 0,
"code": "0vCdhLbwjZZTWZLD",
"guild": {
"id": "165176875973476352",
Expand Down