SEservicechannel
AfterHours

Add a holiday

Adds a holiday to the specified location. <br />Send this request GET /locations/{locationId}/holidays to get the location holidays. <br />Learn how to manage holidays for a location in ServiceChannel University. <br />Example Request

            POST /locations/{locationId}/holidays
            {
             "HolidayName": "Happy Weekend",
             "OpenTime": "10:00 AM",
             "CloseTime": "06:00 PM",
             "ClosedAllDay": false,
             "Frequency": "Yearly",
             "StartDate": "2021-07-03T00:10:00.308Z",
             "RepeatEvery": "1",
             "RepeatBy": "DayOfWeek",
             "RepeatOnDays": [
               "Saturday", "Sunday"
             ],
             "RepeatOnMonths": [
               “June”, "July", "August"
             ]
            }
post/locations/{locationId}/holidays

Request

Path parameters

locationIdinteger required

Unique identifier of the subscriber’s location you want to add or update holidays for.

Request body

HolidayNamestring

Holiday name.

OpenTimestring

Location opening hours.

CloseTimestring

Location closing hours.

ClosedAllDayboolean

Defines whether the location is closed on the specified day.

Frequency'Weekly' | 'Monthly' | 'Yearly' | 'Singular'

Defines how often the holiday occurs. Valid values: Singular, Weekly, Monthly, Yearly.

StartDatestring date-time

Holiday date.

RepeatEverystring byte

Defines intervals for the holiday to repeat. Valid values: a number from 1 to 60. Used in combination with the Frequency values: Yearly, Monthly, Weekly.

RepeatBy'DayOfWeek' | 'DayOfMonth'

Defines whether the holiday repeats on days of the month or week. Valid values: DaysOfWeek, DaysOfMonth

RepeatOnDaysstring[]

Days when the holiday occurs. Used in combination with the Frequency value ‘Weekly’.

RepeatOnMonthsstring[]

Months when the holiday occurs. Used in combination with the Frequency value ‘Yearly’.

Response

The holiday is added to the specified location.

HolidayIdsinteger[]

Changes

No recorded changes to this operation across all 1 revision of this API.