SlotRule

A slot rule defines the recurring time slots available for a service. Slot rules are described by a list of start times and a recurrence rule.

recurrence_rule objectrequired

A recurrence rule describes a repeating pattern of times. Recurrences rules in SavvyCal are modeled after the conventions of iCalendar recurrence rules (RRULE), but are a subset of the full specification.

bydaystring[]

The days of the week on which the recurrence occurs.

Possible values: Value must match regular expression (mo|tu|we|th|fr|sa|su)$

Example: ["mo","we","fr"]

countintegernullable

Number of occurrences at which to end the recurrence.

Possible values: >= 1

freqstringrequired

The frequency of the recurrence.

Possible values: [daily, weekly]

intervalinteger

How often the recurrence rule repeats.

Possible values: >= 1

Example: 2

untildatenullable

Date at which to end the recurrence (in ISO-8601 format).

Example: 2024-01-02

start_timesstring[]required

Array of start times for slots.

Possible values: Value must match regular expression ^\d{2}:\d{2}$

SlotRule

{
  "recurrence_rule": {
    "byday": [
      "mo",
      "we",
      "fr"
    ],
    "freq": "weekly"
  },
  "start_times": [
    "09:00",
    "10:00"
  ]
}