Skip to main content
POST
Add holiday to scheme

Authorizations

X-API-Key
string
header
required

Owner-typed API key (ORGANIZATION, PERSON, VALUE_UNIT). Manage org-scoped lifecycle with /v1/public-api-keys; cross-org governance is restricted to /v1/sys/public-api-keys.

Path Parameters

schemeId
string
required

Parent holiday scheme id

Pattern: \S

Body

application/json

Fixed or floating holiday fields.

name
string
required
Required string length: 2 - 100
Pattern: \S
type
enum<string>
required
Available options:
FIXED,
FLOATING
durationDays
integer<int32>
required
Required range: x >= 1
externalId
string
Maximum string length: 255
description
string
Maximum string length: 300
day
integer<int32>

Required for FIXED holidays; day of month 1-31.

Required range: 1 <= x <= 31
Example:

1

month
integer<int32>

Required for FIXED holidays; month 1-12.

Required range: 1 <= x <= 12
Example:

1

year
integer<int32>

Optional year for a one-time fixed holiday.

Example:

2026

floatingRule
string

Rule required for FLOATING holidays.

Example:

"first Monday in May"

Response

Holiday created

data
object
meta
object