Create user availability schedule

POST 
/calendars/schedules

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

Request

Version stringrequired

API Version

Available optionsv3

application/json

application/json

Body

Bodyrequired

rulesobject[]

Schedule rules defining when the schedule is active

timezonestringrequired

Timezone for the schedule (IANA timezone identifier)

Possible values: Value must match regular expression ^[A-Za-z_]+/[A-Za-z_]+$

locationIdstringrequired

Location ID where this schedule applies

namestringrequired

Human-readable name for the schedule

userIdstringrequired

User ID associated with the schedule

calendarIdsstring[]

Calendar IDs associated with the schedule

Example (auto)

{
  "rules": [
    {
      "type": "wday",
      "day": "monday",
      "intervals": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    }
  ],
  "timezone": "America/New_York",
  "locationId": "IkqiJlXJ7o9h61tCHHod",
  "name": "Business Hours Schedule",
  "userId": "IkqiJlXJ7o9h61tCHHod",
  "calendarIds": [
    "WvVX9LpvlBO6K506xLbp",
    "XyZ8MnQrStUvWxYzAbCdEf"
  ]
}

application/json

Schedule created successfully

application/json

Schema

Schema

scheduleobjectrequired

Schedule

Example (auto)

{
  "schedule": {
    "id": "IkqiJlXJ7o9h61tCHHod",
    "name": "Business Hours Schedule",
    "locationId": "ocQHyuzHvysMo5N5VsXc"
  }
}