Get Started
Portal api methods
Help

POST api/2.0/calendar This function requires authentication

Description

Creates the new calendar with the parameters (name, description, color, etc.) specified in the request

Parameters
Name Description Type Example
name
sent in body
Calendar name string some text
description
sent in body
Calendar description string some text
textColor
sent in body
Event text color string some text
backgroundColor
sent in body
Event background color string some text
timeZone
sent in body
Calendar time zone string some text
alertType
sent in body
Event alert type, in case alert type is set by default Never, FiveMinutes, FifteenMinutes, HalfHour, Hour, TwoHours, Day, Default
sharingOptions
sent in body
Calendar sharing options with other users list of sharing options
iCalUrl
sent in body
iCal url string some text
isTodo
sent in body
Calendar for todo list number 1234
Example
POST api/2.0/calendar
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "name": "some text",
  "description": "some text",
  "textColor": "some text",
  "backgroundColor": "some text",
  "timeZone": "some text",
  "alertType": "Never",
  "sharingOptions": [
    {}
  ],
  "iCalUrl": "some text",
  "isTodo": 1234
}
Returns

Created calendar

Example Response

application/json

{
  "status": 0,
  "response": {
    "canEditTimeZone": false,
    "timeZone": {
      "offset": 0,
      "id": "UTC",
      "name": "UTC"
    },
    "defaultAlert": {
      "type": -1
    },
    "events": [
      {
        "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.3920665Z",
        "end": "2019-12-13T20:36:52.3920665Z",
        "allDay": false,
        "description": "Event Description",
        "title": "Event Name",
        "objectId": "1",
        "sourceId": "calendarID",
        "status": 0
      }
    ],
    "owner": {
      "objectId": "2fdfe577-3c26-4736-9df9-b5a683bb8520",
      "name": "Valery Zykov"
    },
    "objectId": "1",
    "title": "Calendar Name",
    "description": "Calendar Description",
    "backgroundColor": "#000000",
    "textColor": "#ffffff",
    "isEditable": true,
    "permissions": {
      "data": {
        "actions": [
          {
            "id": "read",
            "name": "Read only",
            "defaultAction": true
          }
        ],
        "items": [
          {
            "selectedAction": {
              "id": "read",
              "name": "Read only",
              "defaultAction": true
            },
            "canEdit": true,
            "isGroup": true,
            "name": "Everyone",
            "id": "2fdfe577-3c26-4736-9df9-b5a683bb8520"
          }
        ]
      }
    },
    "isShared": true,
    "canAlertModify": true,
    "isHidden": false,
    "isiCalStream": false,
    "isSubscription": false
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <canEditTimeZone>false</canEditTimeZone>
    <timeZone>
      <offset>0</offset>
      <id>UTC</id>
      <name>UTC</name>
    </timeZone>
    <defaultAlert>
      <type>-1</type>
    </defaultAlert>
    <events>
      <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.3920665Z</start>
      <end>2019-12-13T20:36:52.3920665Z</end>
      <allDay>false</allDay>
      <description>Event Description</description>
      <title>Event Name</title>
      <objectId>1</objectId>
      <sourceId>calendarID</sourceId>
      <status>0</status>
    </events>
    <owner>
      <objectId>2fdfe577-3c26-4736-9df9-b5a683bb8520</objectId>
      <name>Valery Zykov</name>
    </owner>
    <objectId>1</objectId>
    <title>Calendar Name</title>
    <description>Calendar Description</description>
    <backgroundColor>#000000</backgroundColor>
    <textColor>#ffffff</textColor>
    <isEditable>true</isEditable>
    <permissions>
      <data>
        <actions>
          <id>read</id>
          <name>Read only</name>
          <defaultAction>true</defaultAction>
        </actions>
        <items>
          <selectedAction>
            <id>read</id>
            <name>Read only</name>
            <defaultAction>true</defaultAction>
          </selectedAction>
          <canEdit>true</canEdit>
          <isGroup>true</isGroup>
          <name>Everyone</name>
          <id>2fdfe577-3c26-4736-9df9-b5a683bb8520</id>
        </items>
      </data>
    </permissions>
    <isShared>true</isShared>
    <canAlertModify>true</canAlertModify>
    <isHidden>false</isHidden>
    <isiCalStream>false</isiCalStream>
    <isSubscription>false</isSubscription>
  </response>
</result>