Skip to main content
POST
Create a schedule override

Path Parameters

id
string
required

The unique, opaque system identifier for a resource. This case-sensitive ID is also used as path parameters in URLs or in other properties or parameters that reference a resource by ID rather than URL.

Body

application/json

Request to create a schedule override.

startsOn
string<date>
required

Start date of the override, in RFC 3339 date format (YYYY-MM-DD).

endsOn
string<date>
required

End date of the override (inclusive), in RFC 3339 date format (YYYY-MM-DD). For a single-day override, use the same date as startsOn.

type
enum<string>
required

Type of override.

Available options:
timeOff,
holiday,
other
startsAt
string<time>

Start time for each override day (HH:MM). Omit with endsAt for a full day, or set both for a timed window; one bound alone is rejected.

endsAt
string<time>

End time for each override day (HH:MM). Omit with startsAt for a full day, or set both for a timed window; one bound alone is rejected.

description
string

Reason or description for the override.

Maximum string length: 255

Response

Created.

A schedule override for time off or modified hours.

id
string
required

Unique identifier for the override.

startsOn
string<date>
required

Start date of the override, in RFC 3339 date format (YYYY-MM-DD).

endsOn
string<date>
required

End date of the override (inclusive), in RFC 3339 date format (YYYY-MM-DD). For a single-day override, use the same date as startsOn.

type
enum<string>
required

Type of override.

Available options:
timeOff,
holiday,
other
createdAt
string<date-time>
required

The date-time when this resource was created, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. This is derived and immutable.

updatedAt
string<date-time>
required

The date-time when this resource was updated, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. This is derived and immutable.

startsAt
string<time>

Start time for each override day (HH:MM). Omit with endsAt for a full day, or set both for a timed window; one bound alone is rejected.

endsAt
string<time>

End time for each override day (HH:MM). Omit with startsAt for a full day, or set both for a timed window; one bound alone is rejected.

description
string

Reason or description for the override.

Maximum string length: 255