Creating holidays

Use the following endpoint to create (POST) a holiday:

POST /admin/v1/holidays

The only required fields are the holiday name and occurrenceDate. The name is a string and the occurrenceDate is a date in ISO-8601 format.

You can also specify values for the following fields:

appliesToAllZones
holidayTags/code

Note: The code within holidayTags is a String that represents a TypeKey from a TypeList of available holiday codes, so you can only specify a value enumerated in that list. To learn how to find more information about which typekeys are available for the holiday typelists, refer to Typelist metadata.

For example, the following request creates a new holiday in ClaimCenter for New Year's Day.

Command

POST /admin/v1/holidays

Request

{
  "data": {
    "attributes": {
        "name": "New Year's Day",
        "occurrenceDate": "2026-01-01"
    }
  }
}

Response

{
    "data": {
        "attributes": {
            "appliesToAllZones": true,
            "holidayTags": [
                {
                    "code": "general",
                    "name": "General"
                }
            ],
            "id": "xc:SykmXn31Po4-cC6hr-I5y",
            "name": "New Year's Day",
            "occurrenceDate": "2026-01-01"
        },
...

Note: The appliesToAllZones flag defaults to true unless you specify otherwise.