Skip to main content
AvailabilityVersion: v3

Create user availability schedule

POST/calendars/schedules

Create new schedule with specified rules, timezone, location, user and calendar associations.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:calendars.write
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3
Example:v3

Body

rulesobject[]

Schedule rules defining when the schedule is active

timezonestringrequired

Timezone for the schedule (IANA timezone identifier)

Example:America/New_York
locationIdstringrequired

Location ID where this schedule applies

Example:IkqiJlXJ7o9h61tCHHod
namestringrequired

Human-readable name for the schedule

Example:Business Hours Schedule
userIdstringrequired

User ID associated with the schedule

Example:IkqiJlXJ7o9h61tCHHod
calendarIdsstring[]

Calendar IDs associated with the schedule

Example:["WvVX9LpvlBO6K506xLbp","XyZ8MnQrStUvWxYzAbCdEf"]

Response

Schedule created successfully

scheduleobjectrequired

Schedule