Skip to main content
POST
Create Holiday

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
tenantId
number
required
businessHoursId
number
required
name
string
required
Minimum string length: 3
isRecurring
boolean
required
startDate
string<date> | null
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
endDate
string<date> | null
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
isClosed
boolean
required
month
required
Available options:
1
day
required
Available options:
1
dayOfWeek
required
Available options:
0
weekOfMonth
required
Available options:
1
operatingHours
object | null
required
mediaFileId
number | null
required
Required range: x > 0
notifyDaysBefore
number | null
required
Required range: x >= 0

Response

200 - application/json

Created holiday

id
number
required

Holiday ID

tenantId
number
required

Tenant ID

name
string
required

Holiday name

isRecurring
boolean
required

Whether the holiday recurs

startDate
string | null
required

Start date (non-recurring)

endDate
string | null
required

End date (non-recurring)

isClosed
boolean
required

Whether closed for the whole day

month
number | null
required

Recurrence month (1-12)

day
number | null
required

Recurrence day (1-31)

dayOfWeek
number | null
required

Recurrence day of week (0-6)

weekOfMonth
number | null
required

Recurrence week of month (1-5)

operatingHours
any | null
required

Operating hours or null

notifyDaysBefore
number | null
required

Notify days before

businessHours
object | null
required

Associated business hours profile

mediaFile
object | null
required

Associated media file