Create Office Hours Exception Request

REST API Reference

The request payload for creating an office hours exception. Omit time_intervals when exception_type is closed. Any other field, apart from id and office_hours_schedule_id, is rejected with a 400 error.

exception_datestring, (date)required

The date the exception applies to, in YYYY-MM-DD format. A schedule can have only one exception for each date; a second one returns a 422 error.

Example:"2026-12-25"

exception_typestringrequired

The type of exception.

Enum:"closed""custom_hours"

Example:"closed"

namestring

An optional name for the exception.

Example:"Christmas Day"

time_intervalsArray of objects or null(Office Hours Time Interval)

The open intervals for the exception date. Required for custom_hours; omit for closed, which returns a 422 error if intervals are sent. start_minute and end_minute must be on a 15-minute boundary. Don't send day_of_week; it is read-only and a request that includes it is rejected with a 400 error.

recurring_annuallyboolean

Whether the exception repeats every year on the same date.

Example:true

{
  "exception_date": "2026-12-25",
  "exception_type": "closed",
  "name": "Christmas Day",
  "time_intervals": [
    { … }
  ],
  "recurring_annually": true
}