Create a new event in the default calendar

POST /api/2.0/calendar/event

Request

Creates a new event in the default calendar with the parameters specified in the request.

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

Event name

descriptionstring

Event description

startDatestring

Event start date

endDatestring

Event end date

repeatTypestring

Event repeat type (RRULE string in the iCal format)

alertTypeinteger

Event notification type

isAllDayLongboolean

Event duration type: all day long or not

sharingOptionsarray of object

Event sharing access parameters

Examples

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

Responses

200

Event list

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

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).