The POST Holiday Hours for Locations and ChannelLinks endpoint allows partners to update holiday hours for a list of locations and their associated channel links. This endpoint provides flexibility in setting holiday hours both at the location level and for specific channel links within each location.
Request Body
The request body should be in JSON format and include an array of location objects. Each location object should contain the following information:
Key | Description | Type |
---|---|---|
id | The locationId for the location that the holiday hours are being updated | string |
channels | An array of channel link objects within the location, each with its own set of holiday hours | array |
id | The channelLinkId | string |
holidays | An array of holiday periods during which the channel should remain closed | array |
startTime | The start time of the holiday period in ISO 8601 date-time format (e.g., "2021-12-19T15:53:00Z"). | timestamp |
endTime | The end time of the holiday period in ISO 8601 date-time format (e.g., "2021-12-19T16:10:00Z"). | timestamp |
When you're making updates to a location and its associated channels, you have the option to set holiday hours for each channel individually.
If you only make changes to one channel within a location and don't specify holiday hours for the others, the location will default to using standard holiday hours.
Now, if your input data indicates holiday time slots for the location and for one or more specific channel links, those mentioned channel links will have their unique holiday hours. The other channel links, on the other hand, will still follow the holiday hours set at the location level.