Create an out-of-office entry

POST

/appointments/out-of-office

• Production
• QA

Create an out-of-office entry for the calling user. While active, the user’s slots are blocked for booking. start and end may be local calendar dates paired with time_zone or legacy ISO-8601 datetimes. Optional to_user_id exposes an alternative teammate booking path.

Authorizations

• BearerAuth

Parameters

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Request Body ^required

object

end

required

string

notes

Any of:

string

string

null

null

public_note

Any of:

string

string

null

null

reason

Any of:

string

string

null

null

start

required

string

time_zone

Any of:

string

string

null

null

to_user_id

Any of:

integer

integer

null

null

user_id

Any of:

integer

integer

null

null

Responses

201

Successful Response

object

key

additional properties

any

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string