Update Company Holiday

patch

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

Updates a company holiday with a JSON Merge Patch (RFC 7396) document. Only the fields present in the patch change; countryCodes, audience, and holidayPay replace their stored blocks wholesale when supplied. Send null for endDate to revert to a single-day holiday and null for holidayPay to clear the pay treatment. globalHolidayUuid is read-only and rejected if present.

OAuth Scopes: holidays.write

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

The company holiday ID.

Body Params

JSON Merge Patch payload to update a company holiday. Only the fields present in the document are changed; countryCodes, audience, and holidayPay replace their stored blocks wholesale when supplied. globalHolidayUuid is read-only and rejected if present.

name

string

The name of the holiday. 1-255 characters.

startDate

date

The start date of the holiday.

endDate

The end date of the holiday. Must be greater than or equal to startDate. Send null to clear it and revert to a single-day holiday.

isPublic

boolean

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

countryCodes

array of strings

Country filter as ISO 3166-1 alpha-2 codes. Replaces the stored country filter wholesale; an empty array removes the filter.

countryCodes

audience

object

Who the holiday applies to. Replaces the stored audience block wholesale; sub-rows that no longer apply to the new mode are cleared.

holidayPay

Pay treatment for the holiday. Replaces the stored pay block wholesale; send null to clear it (no special pay handling).

Responses

200The updated company holiday.

400Malformed request body.

401Unauthorized. Missing or invalid authentication.

403Forbidden. Insufficient permissions.

404Holiday not found.

415Unsupported media type. The request Content-Type is not application/merge-patch+json.

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