API v2 Docs - Calendar Endpoint

The calendar endpoints allows you to get, edit, and list calendars for a specific guild.

---

calendar/get

Returns the specified calendar's data.

Example Request Body

				{
				"guild_id": 375357265198317579,
				"calendar_number": 1
				}
				

Example Response

				{
				"calendar_id": "[email protected]",
				"calendar_address": "[email protected]",
				"calendar_number": 1,
				"external": false,
				"summary": "Guild Calendar",
				"description": "This is our guild calendar",
				"timezone": "America/Chicago"
				}
				

Supported Values in Request

Key	Value Type	Info	Required
guild_id	string	The Guild ID	True
calendar_number	int	The calendar's number (1 for the main calendar)	True

Returned Values

Key	Value Type	Info
calendar_id	String	The calendar's google ID
calendar_address	String	The calendar's google Address
calendar_number	int	The Calendar Number *1 for main calendar*
external	Boolean	Whether or not this is an external calendar (false, owned by DisCal)
summary	String	The calendar's name/summary
description	String	The calendar's long description
timezone	String	The calendar's timezone

---

calendar/list

Returns a list of all the guild's calendars.

Example Request Body

				{
				"guild_id": 375357265198317579
				}
				

Example Response

				{
				"calendars": [{
					"calendar_id": "[email protected]",
					"calendar_address": "[email protected]",
					"calendar_number": 1,
					"external": false,
					"summary": "Guild Calendar",
					"description": "This is our guild calendar",
					"timezone": "America/Chicago"
				}]
				}
				

Supported Values in Request

Key	Value Type	Info	Required
guild_id	string	The Guild ID	True

Returned Values

Key	Value Type	Info
calendars	JSON Array	An array of all of the guild's calendars
calendars.calendar_id	String	The calendar's google ID
calendars.calendar_address	String	The calendar's google Address
calendars.calendar_number	int	The Calendar Number *1 for main calendar*
calendars.external	Boolean	Whether or not this is an external calendar (false, owned by DisCal)
calendars.summary	String	The calendar's name/summary
calendars.description	String	The calendar's long description
calendars.timezone	String	The calendar's timezone

---

calendar/update

Allows updating of a calendar's data

Example Request Body

				{
				"guild_id": 375357265198317579,
				"calendar_number": 1,
				"summary": "Server Calendar",
				"description": "Calendar's description updating via the API",
				"timezone": "America/New_York"
				}
				

Example Response

				{
				"message": "Calendar successfully updated!"
				}
				

Supported Values in Request

Key	Value Type	Info	Required
guild_id	string	The Guild ID	True
calendar_number	int	The Calendar Number *1 for main calendar*	True
summary	String	The calendar's name/summary	False
description	String	The calendar's long description	False
timezone	String	The calendar's timezone	False

Returned Values

Key	Value Type	Info
message	String	Info on the status of the calendar update

---

calendar/delete

Allows deleting of a guild's calendar

Example Request Body

				{
				"guild_id": 375357265198317579,
				"calendar_number": 1
				}
				

Example Response

				{
				"message": "Successfully deleted calendar!"
				}
				

Supported Values in Request

Key	Value Type	Info	Required
guild_id	string	The Guild ID	True
calendar_number	int	The Calendar Number *1 for main calendar*	True

Returned Values

Key	Value Type	Info
message	String	Info on the status of the calendar delete