Get Started
Usage API
More information

PUT api/2.0/calendar/{calendarId}/{eventId} 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
calendarId
sent in url
Calendar ID string some text
eventId
sent in url
Event ID number 1234
name
sent in body
New event name string some text
description
sent in body
New event description string some text
startDate
sent in body
New event start date Date and Time Roundtrip format: 2008-04-10T06-30-00.000Z
endDate
sent in body
New event end date Date and Time Roundtrip format: 2008-04-10T06-30-00.000Z
repeatType
sent in body
New event recurrence type (RRULE string in iCal format) string some text
alertType
sent in body
New event notification type Never, FiveMinutes, FifteenMinutes, HalfHour, Hour, TwoHours, Day, Default
isAllDayLong
sent in body
New event duration type: all day long or not Bool value true
sharingOptions
sent in body
New event sharing access parameters list of sharing options
status
sent in body
New event status Tentative, Confirmed, Cancelled
Example
PUT api/2.0/calendar/some+text/1234
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": [
    {}
  ],
  "status": "tentative"
}
Returns

Updated list of events

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-27T01:24:24.7200917Z",
      "end": "2021-10-27T01:24:24.7200917Z",
      "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-27T01:24:24.7200917Z</start>
    <end>2021-10-27T01:24:24.7200917Z</end>
    <allDay>false</allDay>
    <description>Event Description</description>
    <title>Event Name</title>
    <objectId>1</objectId>
    <sourceId>calendarID</sourceId>
    <status>0</status>
  </response>
</result>