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

Description

Creates a new event in the default calendar with the parameters specified in the request.

Parameters

Name	Description	Type	Example
name sent in body	Event name	string	some text
description sent in body	Event description	string	some text
startDate sent in body	Event start date	Date and Time	Roundtrip format: 2008-04-10T06-30-00.000Z
endDate sent in body	Event end date	Date and Time	Roundtrip format: 2008-04-10T06-30-00.000Z
repeatType sent in body	Event repeat type (RRULE string in the iCal format)	string	some text
alertType sent in body	Event notification type	Never, FiveMinutes, FifteenMinutes, HalfHour, Hour, TwoHours, Day, Default	Never
isAllDayLong sent in body	Event duration type: all day long or not	Bool value	true
sharingOptions sent in body	Event sharing access parameters	list of sharing options

Example

POST api/2.0/calendar/event
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": [
    {}
  ]
}

Returns

Event list

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "objectId": "1",
      "sourceId": "calendarID",
      "title": "Event Name",
      "description": "Event Description",
      "start": "2020-12-01T06:36:10.8645482Z",
      "end": "2020-12-01T06:36:10.8645482Z",
      "allDay": false,
      "repeatRule": "",
      "isShared": true,
      "permissions": {
        "Data": {
          "actions": [
            {
              "id": "read",
              "name": "Read only",
              "defaultAction": true,
              "defaultStyle": "read"
            }
          ],
          "items": [
            {
              "id": "2fdfe577-3c26-4736-9df9-b5a683bb8520",
              "name": "Everyone",
              "isGroup": true,
              "canEdit": true,
              "selectedAction": {
                "id": "read",
                "name": "Read only",
                "defaultAction": true,
                "defaultStyle": "read"
              }
            }
          ]
        }
      },
      "isEditable": false,
      "alert": {
        "Type": -1
      },
      "owner": {
        "objectId": "2fdfe577-3c26-4736-9df9-b5a683bb8520",
        "name": "Valery Zykov"
      },
      "canUnsubscribe": true,
      "uniqueId": "1234wda",
      "status": 0,
      "TenantId": "1",
      "Todo": true
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <objectId>1</objectId>
    <sourceId>calendarID</sourceId>
    <title>Event Name</title>
    <description>Event Description</description>
    <start>2020-12-01T06:36:10.8645482Z</start>
    <end>2020-12-01T06:36:10.8645482Z</end>
    <allDay>False</allDay>
    <repeatRule />
    <isShared>True</isShared>
    <permissions>
      <Data>
        <actions>
          <id>read</id>
          <name>Read only</name>
          <defaultAction>True</defaultAction>
          <defaultStyle>read</defaultStyle>
        </actions>
        <items>
          <id>2fdfe577-3c26-4736-9df9-b5a683bb8520</id>
          <name>Everyone</name>
          <isGroup>True</isGroup>
          <canEdit>True</canEdit>
          <selectedAction>
            <id>read</id>
            <name>Read only</name>
            <defaultAction>True</defaultAction>
            <defaultStyle>read</defaultStyle>
          </selectedAction>
        </items>
      </Data>
    </permissions>
    <isEditable>False</isEditable>
    <alert>
      <Type>-1</Type>
    </alert>
    <owner>
      <objectId>2fdfe577-3c26-4736-9df9-b5a683bb8520</objectId>
      <name>Valery Zykov</name>
    </owner>
    <canUnsubscribe>True</canUnsubscribe>
    <uniqueId>1234wda</uniqueId>
    <status>0</status>
    <TenantId>1</TenantId>
    <Todo>True</Todo>
  </response>
</result>

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

Get information

Get help