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 occurrenceDate field is a
datetime field and uses ISO-8601 format. It supports setting a UTC
offset. To use a UTC offset, append the number of hours difference ahead (+) or behind
(-) UTC in place of Z (UTC).Important: Do not specify a time other than midnight (current server time) in
the
occurrenceDate field. The server time is the current time of
the InsuranceSuite instance. If any other time is specified, InsuranceSuite will not
properly recognize the holiday when consulting the business calendar.For example, the following request (with the minimum required fields) creates the New
Year's Day holiday for all zones, assuming the server time zone is currently UTC-8 (Los
Angeles - Pacific Standard Time). Because UTC-8 is eight hours behind UTC, an offset
(-08:00) is specified in the request. In the response, note that
the time is in UTC (8:00 AM).
Command
POST /admin/v1/holidays
Request
{
"data": {
"attributes": {
"name": "New Year's Day",
"occurrenceDate": "2026-01-01T00:00:00.000-08:00"
}
}
}
Response
{
"data": {
"attributes": {
"appliesToAllZones": true,
"holidayTags": [
{
"code": "general",
"name": "General"
}
],
"id": "cc:SykmXn31Po4-cC6hr-I5y",
"name": "New Year's Day",
"occurrenceDate": "2026-01-01T08:00:00.000Z"
},
...