Skip to navigation

Create User Availability Schedule

Creates a new availability schedule for the authenticated user. The schedule is not applied to any event type until configured separately.

Rules requirements:

  • Must include exactly one wday rule for each day of the week (sunday through saturday).
  • date rules are optional overrides on top of the weekly rules.
  • Date rules dated before today, in the schedule’s timezone, will return 400 Bad Request.
  • An empty intervals array means no availability for that weekday or date.
Required scopes

availability:write

Authentication

AuthorizationBearer
OAuth 2.0
OR
AuthorizationBearer
Personal Access Token

Request

This endpoint expects an object.
namestringRequired
The name of this Availability Schedule.
timezonestringRequired
The timezone for which this Availability Schedule is originated in.
ruleslist of objectsRequired
Complete set of availability rules for the schedule. Must include exactly one wday rule for each day of the week. date rules are optional overrides on top of the weekly rules.

Response

Created
resourceobject
The availability schedule set by the user.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error
500
Internal Server Error