Availability
Availability rule reference
Review availability rule kinds, fields, scope, and evaluation behavior.
Rule kinds
| Kind | Administrator goal | Main values |
|---|---|---|
hours | Create weekday windows and a time-picker interval. | weekdays, start_time, end_time, slot_minutes |
block | Close a period for the organization or one scope. | starts_at, ends_at, scope_key, scope_value |
capacity | Limit concurrent bookings in fixed time buckets. | max_concurrent, slot_minutes, scope_key |
gap | Add a minimum gap between bookings in the same scope. | gap_minutes, scope_key |
custom | Apply organization-specific logic deployed by the platform. | Platform-managed values |
An organization administrator can create and change the first four kinds. The platform manages
a custom rule with its deployed logic. It is not available for dashboard changes.
Common fields
| Field | Meaning |
|---|---|
target | The data restricted by the rule. It currently uses reservations. |
time_key | The field that contains the booking time. The default is starts_at. |
scope_key | A custom field key for a resource such as equipment or staff. Empty means the whole organization. |
position | The rule order in the administrator list. |
Rules with a scope_key use the same custom field value from each reservation. A scoped block
also requires a scope_value.
Evaluation behavior
- Several business-hour windows can open on the same weekday.
- When any hours rule exists, a booking must be inside at least one open window.
- A closure includes its start and excludes its end.
- Capacity uses fixed buckets of
slot_minutes. - A gap uses the actual distance between a candidate and existing bookings.
- Cancelled, no-show, and completed reservations do not consume capacity or gaps.
- Every rule is checked again during a write.
- A failed
customcheck rejects the booking for safety.
Suggested times
The slot_minutes value on a business-hour window controls its displayed interval. The system
uses the smallest interval from another rule when the window has no value. It uses 30 minutes
when no rule provides an interval. No hours rule produces an empty suggestion list.