Holidays

All InsuranceSuite applications allow an administrator or managerial user with the appropriate permissions to set certain dates on the annual calendar as holidays and limit holidays to certain geographic zones.

A holiday is limited to a single date. It cannot span multiple consecutive days.

Managing holidays is important to determine days when an insurer is not open for business so that activities can include holidays in determining activity due dates. In addition, it affects app-specific business calendar functionality such as the send date for recurring checks in ClaimCenter.

For example, setting Thanksgiving to the last Thursday in November (United States), and Thanksgiving to the second Monday in October (Canada). In this case each holiday is limited to a certain geographic zone. Geographic zones can include countries, states, counties, provinces, territories, and so on. See Geographic zones and Associating holidays with geographic zones.

Other holiday attributes in the base application include designating a holiday either as a company holiday, federal (national) holiday, or a general holiday. In Cloud API, this designation is the holidayTags object.

These attributes are not available in all applications. The following describes the holidayTags available by default in each application:

BillingCenter: General
ClaimCenter: Company Holidays; Federal Holidays; General
ContactManager: General
PolicyCenter: Company Holidays; General

For more information on the business functionality of holidays in PolicyCenter, see the Application Guide.

While holidays are not available to manage in the ContactManager user interface, you can work with holidays endpoints in Cloud API for ContactManager as long as you have the appropriate permissions (perm.Holiday.view and buswkmanage).

Querying for holidays

Use the following endpoints to query for holidays:

GET /admin/v1/holidays
GET /admin/v1/holidays/{holidayId}

For example, the following request in ClaimCenter retrieves information about holiday xc:SVtboW6sge5-2PbgWx4Ks (Independence Day - United States):

Command

GET /admin/v1/holidays/xc:SVtboW6sge5-2PbgWx4Ks

Response

{
    "data": {
        "attributes": {
            "appliesToAllZones": false,
            "holidayTags": [
                {
                    "code": "FederalHolidays",
                    "name": "Federal Holidays"
                }
            ],
            "id": "xc:SVtboW6sge5-2PbgWx4Ks",
            "name": "Independence Day",
            "occurrenceDate": "2025-07-04"
        },
        ...

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.

Modifying and deleting holidays

Modifying holidays

Use the following endpoint to modify a holiday:

PATCH /admin/v1/holidays/{holidayId}

You can modify the following attributes:

appliesToAllZones
holidayTags/code
name

For example, the following request modifies the New Year's Day holiday (ID of xc:SykmXn31Po4-cC6hr-I5y) in ClaimCenter to designate it as a company holiday by changing the code within its holidayTags.

Command

PATCH /admin/v1/holidays/xc:SykmXn31Po4-cC6hr-I5y

Request

{
  "data": {
    "attributes": {
            "holidayTags": [
                    {
                        "code": "CompanyHolidays"
                    }
                ]
            }
  }
}

Response

{
    "data": {
        "appliesToAllZones": false,
        "holidayTags": [
            {
                "code": "CompanyHolidays",
                "name": "Company Holidays"
            }
        ],
        "id": "xc:SykmXn31Po4-cC6hr-I5y",
        "name": "New Year's Day",
        "occurrenceDate": "2026-01-01"
    }
}

Deleting holidays

Use the following endpoint to delete a holiday:

DELETE /admin/v1/holidays/{holidayId}

For example, the following request deletes the holiday with the id of pc:SykmsaXoNo4-cC6hr-I5y in PolicyCenter.

Command

DELETE /admin/v1/holidays/xc:SykmsaXoNo4-cC6hr-I5y

<no request body>

Associating holidays with geographic zones

Some holidays need to be limited to certain geographic areas such as a country, state, or other region. For example, Independence Day (July 4th) is limited to the United States only.

For more information on geographic zones, see Geographic zones.

Querying for geographic zone information

You can query for:

All geographic zones for a specific holiday:
- GET /admin/v1/holidays/{holidayId}/geographic-zones
A specific geographic zone for a specific holiday:
- GET /admin/v1/holidays/{holidayId}/geographic-zones/{holidayZoneId}

For example, the following retrieves all the geographic zones where the Independence Day Holiday (ID of xc:SVtboW6sge5-2PbgWx4Ks) is an official holiday:

Command

GET admin/v1/holidays/xc:SVtboW6sge5-2PbgWx4Ks/geographic-zones

Response

{
    "count": 1,
    "data": [
        {
            "attributes": {
                "code": "US",
                "country": {
                    "code": "US",
                    "name": "United States"
                },
                "id": "xc:SH7Z3TYwHofTr550zAn23",
                "zoneType": {
                    "code": "country",
                    "name": "Country"
                }
            },

Creating geographic zones for a holiday

You can create a geographic zone for a holiday. For example, you would do this to designate that a holiday applies to another geographic zone. To do this, all that is needed is the id of the zone in the request body.

For example, the following request in ClaimCenter associates the US state of Colorado (CO) (ID of US:SJgWm2DZDRbn6zSBw8AbX) with the Cesar Chavez Day holiday, as it is an optional holiday in that state:

Command

POST admin/v1/holidays/xc:SSivbi19APF67brdNHwj0/geographic-zones

Request

{
  "data": {
    "attributes": {
      "geographicZone": {
        "id": "US:SJgWm2DZDRbn6zSBw8AbX"
      }
    }
  }
}

Response

{
    "data": {
        "attributes": {
            "code": "CO",
            "country": {
                "code": "US",
                "name": "United States"
            },
            "id": "xc:SmLiC47UjnoWZlKHWjVfQ",
            "zoneType": {
                "code": "state",
                "name": "State"
            }
        },
...

Deleting geographic zones for a holiday

You can delete a geographic zone for a holiday. In that way, a particular holiday no longer applies to a particular zone.

Use the following endpoint to delete a geographic zone for a holiday:

DELETE /admin/v1/holidays/{holidayId}/geographic-zones/{holidayZoneId}

For example, the following request deletes the geographic zone with the id of xc:SmLiC47UjnoWZlKHWjVfQ in ClaimCenter for the Cesar Chavez Day holiday.

Command

DELETE admin/v1/holidays/xc:SSivbi19APF67brdNHwj0/geographic-zones/xc:SmLiC47UjnoWZlKHWjVfQ