Get Started
Portal api methods
Help

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

Description

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

Parameters
Name Description Type Example
calendarId
sent in body
ID of the calendar where the event is created number 1234
ics
sent in body
Event in iCal format string some text
alertType
sent in body
Event notification type Never, FiveMinutes, FifteenMinutes, HalfHour, Hour, TwoHours, Day, Default
sharingOptions
sent in body
Event sharing access parameters list of sharing options
eventUid
sent in body
Event uid string some text
Example
POST api/2.0/calendar/icsevent
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "calendarId": 1234,
  "ics": "some text",
  "alertType": "Never",
  "sharingOptions": [
    {}
  ],
  "eventUid": "some text"
}
Returns

Event

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-12-13T20:36:52.4077012Z",
      "end": "2019-12-13T20:36:52.4077012Z",
      "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-12-13T20:36:52.4077012Z</start>
    <end>2019-12-13T20:36:52.4077012Z</end>
    <allDay>false</allDay>
    <description>Event Description</description>
    <title>Event Name</title>
    <objectId>1</objectId>
    <sourceId>calendarID</sourceId>
    <status>0</status>
  </response>
</result>