Get Started
Usage API
More information

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

Description

Updates the existing iCal event in the selected calendar with the ID specified in the request.

Parameters
Name Description Type Example
eventId
sent in body
Event ID number 1234
calendarId
sent in body
Calendar ID string some text
ics
sent in body
Event in the iCal format string some text
alertType
sent in body
New event notification type Never, FiveMinutes, FifteenMinutes, HalfHour, Hour, TwoHours, Day, Default
sharingOptions
sent in body
New event sharing access parameters list of sharing options
fromCalDavServer
sent in body
Defines if the request is from the CalDav server or not Bool value true
ownerId
sent in body
New 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": "2021-10-17T17:55:51.9040514Z",
      "end": "2021-10-17T17:55:51.9040514Z",
      "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>2021-10-17T17:55:51.9040514Z</start>
    <end>2021-10-17T17:55:51.9040514Z</end>
    <allDay>false</allDay>
    <description>Event Description</description>
    <title>Event Name</title>
    <objectId>1</objectId>
    <sourceId>calendarID</sourceId>
    <status>0</status>
  </response>
</result>