Create Office Hours Exception Request

Home/

REST API Reference

The request payload for creating an office hours exception. Omit time_intervals when exception_type is closed.

exception_datestring, (date)required

The date the exception applies to, in YYYY-MM-DD format.

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.

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
}