Skip to main content
POST
Create an office hours schedule

Holidays and exceptions

Use exceptions to configure named holidays, closures and extra opening periods. Dates use the schedule timezone. On update, omit the array to preserve existing exceptions, or send [] to clear them. See Office hours and holidays for precedence, recurrence and examples.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required

Schedule name (e.g. "Business Hours", "Weekend Support")

iana_timezone
string
required

IANA timezone for the schedule (e.g. "America/New_York", "Europe/London", "Asia/Tokyo")

shifts
object[]
required

Time blocks when support is available. Use day ranges like "monday_to_friday" for convenience.

exceptions
object[]

Omit to preserve existing exceptions; send [] to clear them

Maximum array length: 200

Response

Default Response

id
string
required

Office hours schedule ID

name
string
required

Schedule name (e.g. "Weekday Support", "Weekend Hours")

iana_timezone
string
required

IANA timezone (e.g. "America/New_York", "Europe/London")

created_at
string<date-time>
required
updated_at
string<date-time>
required
exceptions
object[]
required
Maximum array length: 200
shifts
object[]
required

The time blocks when support is available