Navigation Menu

Create a calendar

POST /api/2.0/calendar/

Request

Creates a new calendar with the parameters (name, description, color, etc.) specified in the request.

Note: Please note that the list of events in the response will be empty.

Authorization

An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.

Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json.

Content-Typeenum of string

Can be one of: application/json.

Body

namestring

Calendar name

descriptionstring

Calendar description

textColorstring

Event text color

backgroundColorstring

Event background color

timeZonestring

Calendar time zone

alertTypeinteger

Event alert type, in case alert type is set by default

sharingOptionsarray of object

Calendar sharing options with other users

iCalUrlstring

iCal URL

isTodointeger

Defines if the to-dos are shown in the calendar

Examples

POST /api/2.0/calendar/ HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com
curl --request POST \
  --url https://example.com/api/2.0/calendar/ \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

Created calendar

IsSubscriptionboolean
iCalUrlstring
IsiCalStreamboolean
IsHiddenboolean
CanAlertModifyboolean
IsSharedboolean
Permissionsobject
Dataobject
AvailableOptionsarray of object
Idstring
Namestring
Defaultboolean
DefaultStylestring
Itemsarray of object
ItemIdstring
ItemNamestring
IsGroupboolean
CanEditboolean
SharingOptionobject
Idstring
Namestring
Defaultboolean
DefaultStylestring
UserParamsarray of object
Idstringformat: uuid
Namestring
IsEditableboolean
TextColorstring
BackgroundColorstring
Descriptionstring
Titlestring
Idstring
IsTodointegerformat: int32
Ownerobject
Idstringformat: uuid
Namestring
Eventsarray of object
Idstring
Uidstring
CalendarIdstring
Namestring
Descriptionstring
AllDayLongboolean
Startstring
Endstring
RepeatRulestring
Alertobject
Typeintegerformat: int32
IsSharedboolean
CanUnsubscribeboolean
IsEditableboolean
Permissionsobject
UserParamsarray of object
Idstringformat: uuid
Namestring
Ownerobject
Idstringformat: uuid
Namestring
Statusenum of integerformat: int32

[0 - Tentative, 1 - Confirmed, 2 - Cancelled]

Can be one of: Tentative, Confirmed, Cancelled.

HasAttachmentsboolean
Todosarray of object
Idstring
Uidstring
CalendarIdstring
Namestring
Descriptionstring
Startstring
Completedstring
Ownerobject
Idstringformat: uuid
Namestring
DefaultAlertTypeobject
Typeintegerformat: int32
TimeZoneInfoobject
Namestring
Idstring
Offsetintegerformat: int32
CanEditTimeZoneboolean

401

Unauthorized

Get Help

  • If you have any questions about ONLYOFFICE Workspace, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).