Skip to main content
POST
/
v2
/
organizations
/
{orgId}
/
users
/
{userId}
/
ooo
Create an out-of-office entry for a user
curl --request POST \
  --url https://api.cal.com/v2/organizations/{orgId}/users/{userId}/ooo \
  --header 'Content-Type: application/json' \
  --data '
{
  "start": "2023-05-01T00:00:00.000Z",
  "end": "2023-05-10T23:59:59.999Z",
  "notes": "Vacation in Hawaii",
  "toUserId": 2,
  "reason": "vacation"
}
'

Headers

​
Authorization
string

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

​
x-cal-secret-key
string

For platform customers - OAuth client secret key

​
x-cal-client-id
string

For platform customers - OAuth client ID

Path Parameters

​
userId
number
required

Body

application/json
​
start
string<date-time>
required

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

Example:

"2023-05-01T00:00:00.000Z"

​
end
string<date-time>
required

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

Example:

"2023-05-10T23:59:59.999Z"

​
notes
string

Optional notes for the out of office entry.

Example:

"Vacation in Hawaii"

​
toUserId
number

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

Example:

2

​
reason
enum<string>

the reason for the out of office entry, if applicable

Available options:
unspecified,
vacation,
travel,
sick,
public_holiday
Example:

"vacation"

Response

201 - undefined