Create schedule unavailability

post

https://api.connecteam.com/scheduler/v1/schedulers/{schedulerId}/unavailability

Create a single unavailability in the specified schedule for a designated user on a given date. The unavailability can be set for the entire day or for a specific part of it. Repeating unavailabilities are currently not supported. The timezone of the unavailability will be determined based on the schedule's settings.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

schedulerId

integer

required

The unique identifier of the schedule

Body Params

userId

integer

required

≥ 1

The unique identifier of the user to which the unavailability will be assigned

isAllDay

boolean

required

Specifies the type of the time period for the unavailability, Defaults to true. If set to false, start and end time fields must be specified.

unavailabilityDate

string

required

The date of the unavailability in ISO format (YYYY-MM-DD).

timezone

The timezone of the unavailability in Tz format (e.g. America/New_York). If not specified, it uses the timezone configured in the app settings.

note

Optional note with additional details about the unavailability

startTime

The start time of the unavailability in ISO format (HH:MM:SS). This field is required if isAllDay set to false.

endTime

The end time of the unavailability in ISO format (HH:MM:SS). This field is required if isAllDay set to false.

Responses

200Successful Response

422Validation Error