Holidays
Public API

Create Company Holiday

Changed on

Creates a company holiday. The body may be fully-specified or carry a globalHolidayUuid that seeds name, dates, and countries from the global catalog entry; partner-supplied values override the catalog defaults.

OAuth Scopes: holidays.write

post/api/v1/holidays

Request

Request body

globalHolidayUuidstring uuid nullable

UUID of a global catalog entry. When supplied, the server seeds name, startDate, endDate, and countryCodes from the catalog entry; partner-supplied values override the catalog defaults.

namestring nullable

The name of the holiday. Required when globalHolidayUuid is not supplied. 1-255 characters.

startDatestring date nullable

The start date of the holiday. Required when globalHolidayUuid is not supplied.

endDatestring date nullable

The end date of the holiday. Null means a single-day holiday. Must be greater than or equal to startDate.

isPublicboolean

Whether the holiday is visible to all employees on calendars, independent of audience. Defaults to true.

countryCodesstring[] nullable

Country filter as ISO 3166-1 alpha-2 codes. An empty array means no country filter. When omitted on a catalog-referenced create, the catalog entry's country is used.

Example request

{
  "name": "Independence Day",
  "startDate": "2026-07-04",
  "endDate": "2026-07-05",
  "countryCodes": [
    "US",
    "CA"
  ],
  "holidayPay": {
    "defaultHours": "8.00",
    "hoursByEmploymentStatus": [
      {
        "employmentStatusListValueId": 17946,
        "hours": "5.00"
      }
    ],
    "multiplier": "1.50"
  }
}

Response

The created company holiday.

idinteger

The ID of the holiday

namestring

The name of the holiday

startDatestring date

The start date of the holiday

endDatestring date nullable

The end date of the holiday. Null for single-day holidays.

isPublicboolean

Whether the holiday is visible to all employees on calendars, independent of audience

countryCodesstring[]

Country filter as ISO 3166-1 alpha-2 codes. Empty means no country filter.

globalHolidayUuidstring uuid nullable

UUID of the global catalog entry this holiday was sourced from. Null for custom holidays.

createdAtstring date-time

ISO 8601 timestamp when the holiday was created

updatedAtstring date-time

ISO 8601 timestamp when the holiday was last updated

deletedAtstring date-time nullable

ISO 8601 timestamp when the holiday was soft-deleted. Null for active holidays.

Example response

{
  "id": 42,
  "name": "Independence Day",
  "startDate": "2026-07-04",
  "endDate": "2026-07-05",
  "countryCodes": [
    "US",
    "CA"
  ],
  "holidayPay": {
    "defaultHours": "8.00",
    "hoursByEmploymentStatus": [
      {
        "employmentStatusListValueId": 17946,
        "hours": "5.00"
      }
    ],
    "multiplier": "1.50"
  },
  "createdAt": "2026-04-30T18:00:00Z",
  "updatedAt": "2026-04-30T18:00:00Z"
}

Changes