Events
Read the API Overview to get started and learn more.
Create event
Creates a new event in the guild.
POST
/
guilds
/
guildId
/
events
Request body
| Field | Type | Description |
|---|---|---|
| title | string | The title of the event |
| location (optional) | string | The location of the event |
| start | Date (UTC) | The start date of the event |
| end | Date (UTC) | The end date of the event |
| invitees | string[] | The ids of the users invited to the event |
Response body
Returns a Event Entity
Returns a 200 status
Update event
Updates an existing event in the guild.
PUT
/
guilds
/
guildId
/
events
/
eventId
Request body
| Field | Type | Description |
|---|---|---|
| title | string | The title of the event |
| location (optional) | string | The location of the event |
| start | Date (UTC) | The start date of the event |
| end | Date (UTC) | The end date of the event |
| invitees | string[] | The ids of the users invited to the event |
Response body
Returns a Event Entity
Returns a 200 status
Delete event
Deletes an existing event in the guild.
DELETE
/
guilds
/
guildId
/
events
/
eventId
Returns a 204 status
Get event
Gets an existing event in the guild.
GET
/
guilds
/
guildId
/
events
/
eventId
Response body
Returns a Event Entity
Returns a 200 status
Event Entity
| Field | Type | Description |
|---|---|---|
| id | string | The id of the event |
| title | string | The title of the event |
| location (optional) | string | The location of the event |
| start | Date (UTC) | The start date of the event |
| end | Date (UTC) | The end date of the event |
| isFromTask | boolean | Whether the event was created from a task |
| invitees | string[] | The ids of the users invited to the event |
| accepted | string[] | The ids of the users who have accepted the invite |
| declined | string[] | The ids of the users who have declined the invite |
| creator | string | The id of the user who created the event |
| repeated | boolean | Whether the event is repeated |
| repeatEnd (optional) | Date (UTC) | The end date of the repeat |
| repeatIntervalDays (optional) | number | The interval in days between each repeat |
