Sign in

v1

latestOpenAPI 3.1.02026-07-26359254.7 MB
Holiday Calendars

Create a holiday calendar

<small>Requires the sequences:write scope (or a broader one that includes it).</small>

Creates a new custom holiday calendar.

post/v3/holiday-calendars

Request body

namestring required

Name of the holiday calendar

repeatEveryYearboolean

Whether the holidays should repeat annually

Example request

{
  "name": "Company Holidays 2026",
  "repeatEveryYear": false,
  "holidays": [
    {
      "startDate": "2026-07-04",
      "endDate": "2026-07-04",
      "name": "Independence Day"
    },
    {
      "startDate": "2026-12-24",
      "endDate": "2026-12-26",
      "name": "Christmas Break"
    }
  ]
}

Response

Holiday calendar created successfully

idinteger

Unique identifier for the holiday calendar

namestring

Name of the holiday calendar

calendarTypestring

Type of calendar (e.g., "predefined", "custom")

countryCodestring

ISO 3166-1 alpha-2 country code

repeatEveryYearboolean

Whether the holidays repeat annually

Example response

{
  "id": 3,
  "name": "US Holidays",
  "calendarType": "custom",
  "countryCode": "US",
  "repeatEveryYear": true,
  "holidays": [
    {
      "id": 100,
      "startDate": "2026-12-25",
      "endDate": "2026-12-25",
      "name": "Christmas Day"
    }
  ]
}