Create Company Holiday

post

https://{companyDomain}.bamboohr.com/api/v1/holidays

Creates a company holiday. The body may be fully-specified or carry a globalHolidayUuid that seeds name, dates, and countries from the global catalog entry; partner-supplied values override the catalog defaults.

OAuth Scopes: holidays.write

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Payload to create a company holiday. May be fully-specified or reference a global catalog entry via globalHolidayUuid. name and startDate are required unless seeded by globalHolidayUuid.

globalHolidayUuid

UUID of a global catalog entry. When supplied, the server seeds name, startDate, endDate, and countryCodes from the catalog entry; partner-supplied values override the catalog defaults.

name

The name of the holiday. Required when globalHolidayUuid is not supplied. 1-255 characters.

startDate

The start date of the holiday. Required when globalHolidayUuid is not supplied.

endDate

The end date of the holiday. Null means a single-day holiday. Must be greater than or equal to startDate.

isPublic

boolean

Defaults to true

Whether the holiday is visible to all employees on calendars, independent of audience. Defaults to true.

countryCodes

Country filter as ISO 3166-1 alpha-2 codes. An empty array means no country filter. When omitted on a catalog-referenced create, the catalog entry's country is used.

audience

object

required

Who the holiday applies to

holidayPay

Pay treatment for the holiday. Null means no special pay handling.

Responses

201The created company holiday.

400Malformed request body.

401Unauthorized. Missing or invalid authentication.

403Forbidden. Insufficient permissions.

404The supplied globalHolidayUuid does not exist in the catalog.

409The supplied globalHolidayUuid already exists on an active company holiday.

422Validation error, or the audience or holidayPay block violates its mode rules.