API v1 Docs - Guild Endpoint
The Guild endpoints allows you to get and edit guild settings for the
specified guild.
/settings/get
Returns the specified guild's settings.
Example Request Body
{
"guild_id": 375357265198317579
}
Example Response
{
"external_calendar": false,
"control_role": "everyone",
"discal_channel": "all",
"simple_announcement": false,
"lang": "ENGLISH",
"prefix": "!",
"patron_guild": false,
"dev_guild": true,
"max_calendars": 1
}
Supported Values in Request
Key |
Value Type |
Info |
Required |
guild_id |
long |
The Guild ID |
True |
Returned Values
Key |
Value Type |
Info |
external_calendar |
Boolean |
Whether or not the guild has an external calendar |
control_role |
String |
Role ID of the role required to use DisCal ("everyone") for no role |
discal_channel |
String |
Channel ID of the channel DisCal can be used in. ("all" for no channel
limits)
|
simple_announcement |
Boolean |
Whether or not the guild has simple announcements enabled |
lang |
String |
The language DisCal will post messages in (default "ENGLISH") |
prefix |
String |
Prefix to be used for DisCal commands (default "!") |
patron_guild |
Boolean |
Whether or not the guild has access to patron only features |
dev_guild |
Boolean |
Whether or not the guild has access to features currently being
developed
|
max_calendars |
int |
The maximum amount of calendars the guild can have (default 1) |
/settings/update
Updates the specified guild's settings.
Example Request Body
{
"guild_id": 375357265198317579,
"control_role": "everyone",
"discal_channel": "all",
"simple_announcement": true,
"lang", "ENGLISH",
"prefix": "?"
}
Example Response
{
"Message": "Successfully updated guild settings"
}
Supported Values in Request
Key |
Value Type |
Info |
Required |
guild_id |
long |
The Guild ID |
True |
control_role |
String |
Role ID of the role required to use DisCal ("everyone") for no role |
False |
discal_channel |
String |
Channel ID of the channel DisCal can be used in. ("all" for no channel
limits)
|
False |
simple_announcement |
Boolean |
Whether or not the guild has simple announcements enabled |
False |
lang |
String |
The language DisCal will post messages in (default "ENGLISH") |
False |
prefix |
String |
Prefix to be used for DisCal commands (default "!") |
False |
Returned Values
Key |
Value Type |
Info |
Message |
String |
Status of settings update |