Create holiday list

POST {{baseUrl}}/api/v1/holidayList

This API creates a holiday list in your help desk portal

OAuth Scope

  • Desk.settings.CREATE

Attributes

Attribute NameData TypeDescription
name (required)<String>
Name of the holiday list
holidays (required)<list>
Holidays to define in the list
status (required)<String>
Activation status of the holiday list. Values allowed are ACTIVE and INACTIVE
associatedBusinessHourIds<list>
IDs of the business hour sets associated with the holiday list

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{&quot;modifiedTime&quot;:&quot;2018-12-10T10:36:53.136Z&quot;,&quot;associatedBusinessHours&quot;:[{&quot;businessHourStatus&quot;:&quot;ACTIVE&quot;,&quot;businessHourId&quot;:&quot;4000000101003&quot;,&quot;businessHourName&quot;:&quot;UK Day Shift&quot;},{&quot;businessHourStatus&quot;:&quot;ACTIVE&quot;,&quot;businessHourId&quot;:&quot;4000000101005&quot;,&quot;businessHourName&quot;:&quot;Indian Night Shift&quot;},{&quot;businessHourStatus&quot;:&quot;ACTIVE&quot;,&quot;businessHourId&quot;:&quot;4000000103001&quot;,&quot;businessHourName&quot;:&quot;UK Night Shift&quot;}],&quot;holidays&quot;:[{&quot;from&quot;:&quot;02-20&quot;,&quot;to&quot;:&quot;02-21&quot;,&quot;holidayName&quot;:&quot;Holiday1&quot;},{&quot;from&quot;:&quot;03-26&quot;,&quot;to&quot;:&quot;03-26&quot;,&quot;holidayName&quot;:&quot;Holiday2&quot;},{&quot;from&quot;:&quot;12-24&quot;,&quot;to&quot;:&quot;12-25&quot;,&quot;holidayName&quot;:&quot;Christmas Holidays&quot;}],&quot;createdBy&quot;:&quot;4000000016079&quot;,&quot;name&quot;:&quot;My Company Holidays&quot;,&quot;createdTime&quot;:&quot;2018-12-10T10:36:53.136Z&quot;,&quot;modifiedBy&quot;:&quot;4000000016079&quot;,&quot;id&quot;:&quot;4000000191371&quot;,&quot;status&quot;:&quot;ACTIVE&quot;}