Intercom API (unofficial showcase)
PUT/office_hours_schedules/{office_hours_schedule_id}/office_hours_exceptions/{id}

Update an office hours exception

Updates an existing office hours exception, changing only the fields included in the request. Set exception_type to closed or custom_hours; custom hours require time_intervals, while closed exceptions omit them. Set exception_date in YYYY-MM-DD format and use recurring_annually to indicate whether the exception repeats each year.

3 parameters · 5 body fields
office_hours_schedule_idstringrequired
The unique identifier of the office hours schedule that contains the exception.
idstringrequired
The unique identifier of the office hours exception to update.
Intercom-Versionstringoptional
The Intercom API version to use. Supported versions include the listed values; defaults to 2.17 when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

Partial office hours exception update. Only the fields provided are changed.

exception_datestringoptional
The date the exception applies to, in `YYYY-MM-DD` format.
exception_typestringoptional
The type of exception.
Allowed:closedcustom_hours
namestringoptional
An optional name for the exception.
time_intervalsarray<OfficeHoursTimeInterval>optional
The open intervals for the exception date. Required for `custom_hours`; omit for `closed`.
recurring_annuallybooleanoptional
Whether the exception repeats every year on the same date.

4 status codes
200Returns the updated office hours exception, including its date, type, time intervals, annual recurrence setting, and timestamps.
typestringoptional
The type of the object - always `office_hours_exception`.
idstringoptional
The unique identifier for the office hours exception.
office_hours_schedule_idstringoptional
The unique identifier for the schedule this exception belongs to.
exception_datestringoptional
The date the exception applies to, in `YYYY-MM-DD` format.
exception_typestringoptional
`closed` means the workspace is closed all day; `custom_hours` replaces the regular hours with `time_intervals`.
Allowed:closedcustom_hours
namestringoptional
An optional name for the exception.
time_intervalsarray<OfficeHoursTimeInterval>optional
The open intervals for the exception date. `null` when `exception_type` is `closed`.
recurring_annuallybooleanoptional
Whether the exception repeats every year on the same date.
created_atintegeroptional
The time the exception was created as a Unix timestamp.
updated_atintegeroptional
The time the exception was last updated as a Unix timestamp.
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
404Returned when the requested schedule or exception is not found.

2 documented failures

  • not_found

    Object not found

  • data_invalid

    Integration not found

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
422Returned when the exception data fails validation.

One documented failure

  • data_invalid

    Invalid or duplicated record reference

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 401 is returned when the request is unauthorized. A 404 is returned when the schedule or exception is not found; the office_hours_schedule_id path parameter and id path parameter must identify the associated schedule and exception. A 422 is returned for invalid exception data; exception_type must be closed or custom_hours, and exception_date must use YYYY-MM-DD format. time_intervals is required for custom_hours and should be omitted for closed.