Labels
Read the API Overview to get started and learn more.
Get all labels
Get all labels for a guild by the guilds id
GET /guilds/guildId/labels
Parameters
guildId The id of a discord guild
Responses
200 Response (All labels for the guild):
| Response Field | Type | Description |
|---|---|---|
| labels | array | List of labels |
Create a label
Create a label for a guild
POST /guilds/guildId/labels
Parameters
guildId The id of a discord guild
Request body
| Request Field | Type | Description |
|---|---|---|
| name | string | The name of the label |
| color (optional) | string | The color of the label |
Responses
200 Response (The created label):
| Response Field | Type | Description |
|---|---|---|
| id | string | The id of the label |
| name | string | The name of the label |
| color (optional) | string | The color of the label |
Update a label
Update a label for a guild by the guild and label id
PUT /guilds/guildId/labels/labelId
Parameters
guildId The id of a discord guild
labelId The ID of the label
Request body
| Request Field | Type | Description |
|---|---|---|
| name | string | The name of the label |
| color (optional) | string | The color of the label |
Responses
200 Response (The updated label):
| Response Field | Type | Description |
|---|---|---|
| id | string | The id of the label |
| name | string | The name of the label |
| color (optional) | string | The color of the label |
Delete a label
Delete a label for a guild by the guild and label id
DELETE /guilds/guildId/labels/labelId
Parameters
guildId The id of a discord guild
labelId The ID of the label
Responses
204 Response (The label was deleted): Empty response.
