Skip to content

Latest commit

 

History

History
163 lines (133 loc) · 8.94 KB

Invite.md

File metadata and controls

163 lines (133 loc) · 8.94 KB
sidebar_label
Invite

Invite Resource

Invite Object

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
code string the invite code (unique ID)
guild? partial guild object the guild this invite is for
channel ?partial channel object the channel this invite is for
inviter? user object the user who created the invite
target_type? integer the type of target for this voice channel invite
target_user? user object the user whose stream to display for this voice channel stream invite
target_application? partial application 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 object stage instance data if there is a public Stage instance in the Stage channel this invite is for (deprecated)
guild_scheduled_event? guild scheduled event 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
STREAM 1
EMBEDDED_APPLICATION 2
Example Invite Object
{
  "type": 0,
  "code": "0vCdhLbwjZZTWZLD",
  "guild": {
    "id": "165176875973476352",
    "name": "CS:GO Fraggers Only",
    "splash": null,
    "banner": null,
    "description": "Very good description",
    "icon": null,
    "features": ["NEWS", "DISCOVERABLE"],
    "verification_level": 2,
    "vanity_url_code": null,
    "nsfw_level": 0,
    "premium_subscription_count": 5
  },
  "channel": {
    "id": "165176875973476352",
    "name": "illuminati",
    "type": 0
  },
  "inviter": {
    "id": "115590097100865541",
    "username": "speed",
    "avatar": "deadbeef",
    "discriminator": "7653",
    "public_flags": 131328
  },
  "target_type": 1,
  "target_user": {
    "id": "165176875973476352",
    "username": "bob",
    "avatar": "deadbeef",
    "discriminator": "1234",
    "public_flags": 64
  }
}

Invite Metadata Object

Extra information about an invite, will extend the invite object.

Invite Metadata Structure
Field Type Description
uses integer number of times this invite has been used
max_uses integer max number of times this invite can be used
max_age integer duration (in seconds) after which the invite expires
temporary boolean whether this invite only grants temporary membership
created_at ISO8601 timestamp when this invite was created
Example Invite Metadata
{
  "uses": 0,
  "max_uses": 0,
  "max_age": 0,
  "temporary": false,
  "created_at": "2016-03-31T19:15:39.954000+00:00"
}

Invite Stage Instance Object

warn This is deprecated.

Invite Stage Instance Structure
Field Type Description
members array of partial guild member objects the members speaking in the Stage
participant_count integer the number of users in the Stage
speaker_count integer the number of users speaking in the Stage
topic string the topic of the Stage instance (1-120 characters)
Example Invite Stage Instance
{
  "topic": "The debate is over: diet is better than regular",
  "participant_count": 200,
  "speaker_count": 5 ,
  "members": [
    {
      "roles": [],
      "nick": "NOT API SUPPORT",
      "avatar": null,
      "premium_since": null,
      "joined_at": "2015-04-26T06:26:56.936000+00:00",
      "pending": false,
      "user": {}
    }
  ]
}

Get Invite % GET /invites/{invite.code#DOCS_RESOURCES_INVITE/invite-object}

Returns an invite object for the given code.

Query String Params
Field Type Description
with_counts? boolean whether the invite should contain approximate member counts
guild_scheduled_event_id? snowflake the guild scheduled event to include with the invite

Delete Invite % DELETE /invites/{invite.code#DOCS_RESOURCES_INVITE/invite-object}

Delete an invite. Requires the MANAGE_CHANNELS permission on the channel this invite belongs to, or MANAGE_GUILD to remove any invite across the guild. Returns an invite object on success. Fires an Invite Delete Gateway event.

info This endpoint supports the X-Audit-Log-Reason header.