Create event calendar availability schedule

POST 
/calendars/schedules/event-calendar/:calendarId

Create a new availability schedule specifically for an event calendar. The calendar ID is provided in the path, and schedule rules and timezone are provided in the request body.

Request

Version stringrequired

API Version

Available optionsv3

calendarId stringrequired

Unique identifier of the event calendar

application/json

application/json

Body

Bodyrequired

rulesobject[]required

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_]+$

Example (auto)

{
  "rules": [
    {
      "type": "wday",
      "day": "monday",
      "intervals": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    }
  ],
  "timezone": "America/New_York"
}

application/json

Schedule created successfully for the event calendar

application/json

Schema

Schema

scheduleobjectrequired

The event calendar schedule

Example (auto)

{
  "schedule": {
    "timezone": "America/New_York",
    "rules": [
      {
        "type": "weekday",
        "day": "monday",
        "intervals": [
          {
            "from": "09:00",
            "to": "17:00"
          }
        ]
      }
    ],
    "calendarId": "WvVX9LpvlBO6K506xLbp"
  }
}