Events
Read the API Overview to get started and learn more.
Create a new event
Create a new event for the guild
POST /guilds/guildId/events
Parameters
guildId The id of a discord guild
Request body
| Request Field | Type | Description |
|---|---|---|
| title | string | Title of the event |
| location (optional) | string | Description of the event |
| start | string | Start date and time of the event |
| end | string | End date and time of the event |
| invitees (optional) | array | Invitees of the event |
Responses
200 Response (Event created):
| Response Field | Type | Description |
|---|---|---|
| id | string | Id of the event |
| title | string | Title of the event |
| location (optional) | string | Location of the event |
| start | string | Start date and time of the event |
| end | string | End date and time of the event |
| isFromTask | boolean | Is the event from a task deadline |
| invitees | array | Discord user ids of the invitees |
| accepted | array | Discord user ids of the accepted invitees |
| declined | array | Discord user ids of the declined invitees |
| creator | string | Discord user id of the creator |
| repeated | boolean | Is the event repeated |
| repeatEnd (optional) | string | End date of the repeat |
| repeatIntervalDays (optional) | number | Interval in days for the repeat |
Get an event
Get an event by ID
GET /guilds/guildId/events/eventId
Parameters
guildId The id of a discord guild
eventId The ID of the event
Responses
200 Response (Event retrieved):
| Response Field | Type | Description |
|---|---|---|
| id | string | Id of the event |
| title | string | Title of the event |
| location (optional) | string | Location of the event |
| start | string | Start date and time of the event |
| end | string | End date and time of the event |
| isFromTask | boolean | Is the event from a task deadline |
| invitees | array | Discord user ids of the invitees |
| accepted | array | Discord user ids of the accepted invitees |
| declined | array | Discord user ids of the declined invitees |
| creator | string | Discord user id of the creator |
| repeated | boolean | Is the event repeated |
| repeatEnd (optional) | string | End date of the repeat |
| repeatIntervalDays (optional) | number | Interval in days for the repeat |
Update an event
Update an existing event
PUT /guilds/guildId/events/eventId
Parameters
guildId The id of a discord guild
eventId The ID of the event
Request body
| Request Field | Type | Description |
|---|---|---|
| title | string | The title of the event |
| location (optional) | string | The location of the event |
| start | string | The start date and time of the event |
| end | string | The end date and time of the event |
| invitees (optional) | array | The invitees of the event |
| accepted (optional) | boolean | The acceptance status of the event |
Responses
200 Response (Event updated):
| Response Field | Type | Description |
|---|---|---|
| id | string | Id of the event |
| title | string | Title of the event |
| location (optional) | string | Location of the event |
| start | string | Start date and time of the event |
| end | string | End date and time of the event |
| isFromTask | boolean | Is the event from a task deadline |
| invitees | array | Discord user ids of the invitees |
| accepted | array | Discord user ids of the accepted invitees |
| declined | array | Discord user ids of the declined invitees |
| creator | string | Discord user id of the creator |
| repeated | boolean | Is the event repeated |
| repeatEnd (optional) | string | End date of the repeat |
| repeatIntervalDays (optional) | number | Interval in days for the repeat |
Delete an event
Delete an existing event
DELETE /guilds/guildId/events/eventId
Parameters
guildId The id of a discord guild
eventId The ID of the event
Responses
204 Response (Event deleted): Empty response.
