Get Started
Portal api methods
Help

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

Description

Updates the existing event in the selected calendar with the parameters specified in the request

Parameters
Name Description Type Example
eventId
sent in body
Event ID number 1234
calendarId
sent in body
ID of the calendar where the event belongs string some text
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
fromCalDavServer
sent in body
bool flag says that request from caldav server Bool value true
ownerId
sent in body
Event owner id string some text
Example
PUT api/2.0/calendar/icsevent
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "eventId": 1234,
  "calendarId": "some text",
  "ics": "some text",
  "alertType": "Never",
  "sharingOptions": [
    {}
  ],
  "fromCalDavServer": true,
  "ownerId": "some text"
}
Returns

Updated 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-10-16T09:54:28.9233439Z",
      "end": "2019-10-16T09:54:28.9233439Z",
      "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-10-16T09:54:28.9233439Z</start>
    <end>2019-10-16T09:54:28.9233439Z</end>
    <allDay>false</allDay>
    <description>Event Description</description>
    <title>Event Name</title>
    <objectId>1</objectId>
    <sourceId>calendarID</sourceId>
    <status>0</status>
  </response>
</result>