Sign in

v3

latestSwagger 2.02026-08-067506752.0 MB
calendar

Update an existing calendar

patch/v2/org/{orgId}/calendar/{calendarId}

Path parameters

orgIdstring required

Org identifier (either id or slug)

calendarIdstring required

Calendar id

Request body

type'ANNIVERSARY' | 'BIRTHDAY' | 'COMP_REVIEW' | 'REVIEW' | 'SURVEY' | 'TASK' | 'TIMEOFF' | 'START_DATE' | 'END_DATE' | 'CUSTOM' | 'HOLIDAY'

type of calendar

labelstring

human-readable label for calendar

descriptionstring
colorstring
imagePathstring
emojistring

emoji, if an emoji is used to represent the calendar

sensitive'GLOBAL' | 'ORG' | 'SENSITIVE' | 'PERSONAL' | 'MANAGER' | 'HIGH' | 'PRIVATE'

base sensitivity of this calendar and entities in it -- should be PRIVATE, ORG or HIGH

status'ACTIVE' | 'INACTIVE'

whether the calendar is active or not

Example request

{
  "emoji": "💥",
  "shareAccess": [
    {
      "userId": "5887a7718f138b6a2a0041a7",
      "groupId": "5887a7718f138b6a2a0041a7",
      "fields": "name,image,title"
    }
  ],
  "eligibility": {
    "includePersonIds": [
      "588f7ee98f138b19220041a7"
    ],
    "excludePersonIds": [
      "588f7ee98f138b19220041a7"
    ]
  }
}

Response

No Content