Guilds¶
Warning
The Guild API is currently still in the design process, this means this is subject to heavy change.
Guild¶
name |
type |
id |
int |
name |
string |
description |
string |
banner |
string |
invite_banner |
string |
vanity_url |
string |
verified |
boolean |
partnered |
boolean |
official |
boolean (always |
owner |
int |
emojis |
List of Emoji Objects |
roles |
List of Role Objects |
Role Object¶
name |
type |
id |
int |
name |
string |
position |
int |
color |
string |
permissions |
list of strings which denote the permissions |
Member Object¶
name |
type |
user |
User Object |
nick |
string |
avatar_url |
string, null |
banner_url |
string, null |
joined_at |
ISO8601 timestamp |
deaf |
boolean |
mute |
boolean |
owner |
boolean |
roles |
List of role id’s |
Routes¶
- POST /guilds¶
Create’s a Guild
name
type
name
string
description?
string
Returns a Guild object, if sucessful.
- Request Headers
Authorization – One of
session_id
- Status Codes
201 Created – Success
400 Bad Request – Invalid Data
401 Unauthorized – Unauthorized
- GET /guilds/guild-id¶
Gets a Guild
Returns a Guild object, if sucessful
- Request Headers
Authorization – One of
session_id
- Status Codes
200 OK – Success
401 Unauthorized – Unauthorized
- PATCH /guilds/guild-id¶
Edits the Guild
Returns the Edited objects, if sucessful
- Request Headers
Authorization – One of
session_id
- Status Codes
200 OK – Success
201 Created – Not a Member, or incorrect session_id
203 Non Authoritative Information – Not enough permissions
404 Not Found – Not Found
- DELETE /guilds/guild-id¶
Deletes a Guild
- Request Headers
Authorization – One of
session_id
- Status Codes
201 Created – Not a Member, or incorrect session_id
203 Non Authoritative Information – Not enough permissions
204 No Content – Success (No Content)
404 Not Found – Not Found
- GET /guilds/guild-id/preview¶
Returns a Partial Guild Object, of the Guild
- Status Codes
200 OK – Success
404 Not Found – Not Found
- POST /invites/invite-code¶
Joins a Guild
Returns a Member Object, if sucessful
- Request Headers
Authorization – One of
session_id
- Status Codes
200 OK – Success
404 Not Found – Not Found
401 Unauthorized – Unauthorized