Unavailability and recurring blocks
Manage one-off unavailability blocks and repeating closures so resources and locations stay accurate in availability and booking.
When to use these APIs
- Ad-hoc blocks — Block a resource (or related entity) for vacation, training, or maintenance for specific date ranges.
- Recurring closures — Repeat the same closure pattern (for example, “every Friday after 3pm”) without re-entering each occurrence.
- Calendar views — Fetch unavailability in a calendar-oriented shape for custom UIs.
GET /v3/availability and booking flows already respect these layers; configure blocks here when customers need to see fewer slots or when you must prevent booking during specific times.
One-off unavailability (/v3/unavailability)
/v3/unavailability)The unavailability router covers listing, creating, and managing discrete blocks (not the weekly recurring pattern engine under recurringBlock).
Typical operations (see the API reference for bodies and query parameters):
| Method | Path | Purpose |
|---|---|---|
GET | /v3/unavailability | List unavailability for a resource in a date range |
GET | /v3/unavailability/calendar | Calendar-oriented data for the same scope |
GET | /v3/unavailability/blocks | Fetch blocks with filters |
POST | /v3/unavailability | Create a block |
POST | /v3/unavailability/setUnavailabilityBlocks | Replace or set multiple blocks in one call |
For types of blocks (appointments, holds, padding, OOF, external), see Unavailability in the glossary.
Recurring blocks (/v3/unavailability/recurringBlock)
/v3/unavailability/recurringBlock)Base path: /v3/unavailability/recurringBlock. Use these endpoints when a closure should repeat on a rule-based schedule. Operations include listing, creating, updating, and deleting patterns (including bulk delete where supported). Exact shapes are in the API reference.
How this fits the stack
- Entity operating hours — Baseline hours and layers (allocations, blocks, external calendars) are described in Entity operating hours.
- Single and weekly allocations — Alternative ways to express availability, especially in allocation mode; see Single allocations and Weekly allocations.
- External calendars — Personal busy times often appear as unavailability; see External calendar sync.
Tips
- Prefer narrow date ranges when listing blocks; large windows are slower to query and render.
- After changing blocks, run a focused
GET /v3/availabilitytest for the affected resource and dates to confirm slots match expectations. - For product terminology, use the Glossary.
Related documentation
- Resources overview — How resources use schedules and blocks
- Availability guide — How
GET /v3/availabilityuses these layers - Error codes — Common validation and conflict responses
Updated 4 days ago