Orgs / Users / OOO

Create an out-of-office entry for a user

post/v2/organizations/{orgId}/users/{userId}/ooo

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

userIdnumber required
orgIdnumber required

Headers

Authorizationstring

For non-platform customers - value must be Bearer <token> where <token> is api key prefixed with cal_

x-cal-secret-keystring

For platform customers - OAuth client secret key

x-cal-client-idstring

For platform customers - OAuth client ID

Request body

startstring date-time required

The start date and time of the out of office period in ISO 8601 format in UTC timezone.

endstring date-time required

The end date and time of the out of office period in ISO 8601 format in UTC timezone.

notesstring

Optional notes for the out of office entry.

toUserIdnumber

The ID of the user covering for the out of office period, if applicable.

reason'unspecified' | 'vacation' | 'travel' | 'sick' | 'public_holiday'

the reason for the out of office entry, if applicable

Example request

{
  "start": "2023-05-01T00:00:00.000Z",
  "end": "2023-05-10T23:59:59.999Z",
  "notes": "Vacation in Hawaii",
  "toUserId": 2,
  "reason": "vacation"
}

Response

status'success' | 'error' required

Example response

{
  "status": "success",
  "data": {
    "userId": 2,
    "toUserId": 2,
    "id": 2,
    "start": "2023-05-01T00:00:00.000Z",
    "end": "2023-05-10T23:59:59.999Z",
    "notes": "Vacation in Hawaii",
    "reason": "vacation"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.