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 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 objectthe user who created the invite target_type? integer the type of target for this voice channel invite target_user? user objectthe 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 endpoint when is approximate_member_count? integer approximate count of total members, returned from the endpoint when is expires_at? ?ISO8601 timestamp the expiration date of this invite, returned from the endpoint when is stage_instance? invite stage instance objectstage instance data if there is a public Stage instance in the Stage channel this invite is for
Invite Target Types Type Value STREAM 1 EMBEDDED_APPLICATION 2
Example Invite Object json
{
"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
} ,
"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 json
{
"uses" : 0 ,
"max_uses" : 0 ,
"max_age" : 0 ,
"temporary" : false ,
"created_at" : "2016-03-31T19:15:39.954000+00:00"
}
Invite Stage Instance Object 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 json
{
"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" : { }
}
]
}
Endpoints Get Invite GET/invites/{invite.code}
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 with_expiration? boolean whether the invite should contain the expiration date
Delete Invite DELETE/invites/{invite.code}
Delete an invite. Requires the permission on the channel this invite belongs to, or to remove any invite across the guild. Returns an invite object on success. Fires a Invite Delete Gateway event.