Get Started
Portal api methods
Help

POST api/2.0/calendar/event This function requires authentication

Description

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

Parameters
Name Description Type Example
name
sent in body
Event name string some text
description
sent in body
Event description string some text
startDate
sent in body
Event start date Date and Time Roundtrip format: 2008-04-10T06-30-00.000Z
endDate
sent in body
Event end date Date and Time Roundtrip format: 2008-04-10T06-30-00.000Z
repeatType
sent in body
Event recurrence type (RRULE string in iCal format) string some text
alertType
sent in body
Event notification type Never, FiveMinutes, FifteenMinutes, HalfHour, Hour, TwoHours, Day, Default
isAllDayLong
sent in body
Event duration type: all day long or not Bool value true
sharingOptions
sent in body
Event sharing access parameters list of sharing options
Example
POST api/2.0/calendar/event
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "name": "some text",
  "description": "some text",
  "startDate": "2008-04-10T06-30-00.000Z",
  "endDate": "2008-04-10T06-30-00.000Z",
  "repeatType": "some text",
  "alertType": "Never",
  "isAllDayLong": true,
  "sharingOptions": [
    {}
  ]
}
Returns

Event list

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "owner": {
        "objectId": "2fdfe577-3c26-4736-9df9-b5a683bb8520",
        "name": "Valery Zykov"
      },
      "permissions": {
        "users": [
          {
            "objectId": "2fdfe577-3c26-4736-9df9-b5a683bb8520",
            "name": "Valery Zykov"
          }
        ]
      },
      "isEditable": false,
      "сanUnsubscribe": true,
      "isShared": true,
      "alert": {
        "type": -1
      },
      "repeatRule": "",
      "start": "2019-06-24T18:26:27.1844743Z",
      "end": "2019-06-24T18:26:27.1844743Z",
      "allDay": false,
      "description": "Event Description",
      "title": "Event Name",
      "objectId": "1",
      "sourceId": "calendarID",
      "status": 0
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <owner>
      <objectId>2fdfe577-3c26-4736-9df9-b5a683bb8520</objectId>
      <name>Valery Zykov</name>
    </owner>
    <permissions>
      <users>
        <objectId>2fdfe577-3c26-4736-9df9-b5a683bb8520</objectId>
        <name>Valery Zykov</name>
      </users>
    </permissions>
    <isEditable>false</isEditable>
    <сanUnsubscribe>true</сanUnsubscribe>
    <isShared>true</isShared>
    <alert>
      <type>-1</type>
    </alert>
    <repeatRule></repeatRule>
    <start>2019-06-24T18:26:27.1844743Z</start>
    <end>2019-06-24T18:26:27.1844743Z</end>
    <allDay>false</allDay>
    <description>Event Description</description>
    <title>Event Name</title>
    <objectId>1</objectId>
    <sourceId>calendarID</sourceId>
    <status>0</status>
  </response>
</result>