API v2 Docs - Guild Endpoint

The Guild endpoints allows you to get and edit guild settings for the specified guild.

---

guild/settings/get

Returns the specified guild's settings.

Example Request Body

				{
				"guild_id": 375357265198317579
				}
				

Example Response Body

				{
					"guild_id": 375357265198317579,
					"external_calendar": false,
					"control_role": "everyone",
					"simple_announcements": false,
					"lang": "ENGLISH",
					"prefix": "!",
					"patron_guild": false,
					"dev_guild": true,
					"max_calendars": 1,
					"twelve_hour": true,
					"branded": false
				}
				

Supported Values in Request

Key	Value Type	Info	Required
guild_id	string	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
simple_announcements	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)
twelve_hour	Boolean	Whether the guild is using a 12 hour or 24 hour time format
branded	Boolean	Whether the server is using branding on embeds

---

guild/settings/update

Updates the specified guild's settings.

Example Request Body

				{
				"guild_id": 375357265198317579,
				"control_role": "everyone",
				"simple_announcements": true,
				"lang", "ENGLISH",
				"prefix": "?",
                "twelve_hour": false
				}
				

Example Response

				{
				"Message": "Successfully updated guild settings"
				}
				

Supported Values in Request

Key	Value Type	Info	Required
guild_id	string	The Guild ID	True
control_role	String	Role ID of the role required to use DisCal ("everyone") for no role	False
simple_announcements	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
twelve_hour	Boolean	Whether or not to use the twelve hour time format.	False

Returned Values

Key	Value Type	Info
message	String	Status of settings update