Sign in

v3

latestSwagger 2.02026-08-067506752.0 MB
calendar

Create a new calendar

post/v2/org/{orgId}/calendar

Path parameters

orgIdstring required

Org identifier (either id or slug)

Request body

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

type of calendar

labelstring required

human-readable label for calendar

descriptionstring
colorstring required
imagePathstring
emojistring

emoji, if an emoji is used to represent the calendar

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

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

status'ACTIVE' | 'INACTIVE' required

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

Created a new calendar

idstring required

globally unique id

orgIdstring

parent organization id

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

type of calendar

labelstring required

human-readable label for calendar

descriptionstring
colorstring required
imagePathstring
emojistring

emoji, if an emoji is used to represent the calendar

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

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

status'ACTIVE' | 'INACTIVE' required

whether the calendar is active or not

createIdstring

created by user id

createBehalfIdstring

created on behalf of user id

createAtstring

created timestamp

updateIdstring

last updated by user id

updateBehalfIdstring

last updated on behalf of user id

updateAtstring

last updated timestamp

deleteIdstring

deleted by user id

deleteBehalfIdstring

deleted on behalf of user id

deleteAtstring

deleted timestamp

isBuiltInboolean required

Example response

{
  "id": "665f3aabe88164e4ef6c3a22",
  "orgId": "665f3ad1e47a82bf1d3d180b",
  "emoji": "💥",
  "shareAccess": [
    {
      "userId": "5887a7718f138b6a2a0041a7",
      "groupId": "5887a7718f138b6a2a0041a7",
      "fields": "name,image,title"
    }
  ],
  "eligibility": {
    "includePersonIds": [
      "588f7ee98f138b19220041a7"
    ],
    "excludePersonIds": [
      "588f7ee98f138b19220041a7"
    ]
  },
  "createId": "588f7ee98f138b19220041a7",
  "createBehalfId": "588f7ee98f138b19220041a7",
  "createAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "createAt": "2017-01-24T13:57:52Z",
  "updateId": "588f7ee98f138b19220041a7",
  "updateBehalfId": "588f7ee98f138b19220041a7",
  "updateAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "updateAt": "2017-01-24T13:57:52Z",
  "deleteId": "588f7ee98f138b19220041a7",
  "deleteBehalfId": "588f7ee98f138b19220041a7",
  "deleteAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "deleteAt": "2017-01-24T13:57:52Z"
}