COconnecteam
Schedule:v1:Schedulers:Schedule:Schedule Unavailability

Create schedule 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.

post/scheduler/v1/schedulers/{schedulerId}/unavailability

Request

  • Base URL
    https://api.connecteam.com
  • URL
    https://api.connecteam.com/scheduler/v1/schedulers/{schedulerId}/unavailability
  • Auth
    • API key in header X-API-KEY
    • or OAuth 2
      Client credentials
      Token URL: /oauth/v1/token scopes: schedule.write

Path parameters

schedulerIdinteger required

The unique identifier of the schedule

Request body

userIdinteger required

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

isAllDayboolean 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.

unavailabilityDatestring required

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

timezonestring nullable

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.

notestring nullable

Optional note with additional details about the unavailability

startTimestring nullable

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

endTimestring nullable

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

Response

Successful Response

requestIdstring

Changes

No recorded changes to this operation across all 2 revisions of this API.