Skip to navigation
API ReferenceHolidays

Create Holidays

Creates one or more Holiday for a Resource, a Country, or the entire Workspace.

A Holiday can be created based on multiple crtieria, including a date range, a list of Resource identifiers, and a list of countries. You may use one or more of these criteria when calling CreateHolidays, and the API will expand your criteria into individual Holiday records for each combination of criteria.

A Holiday is a defined date when one or more Resources are not available for work. Holidays may be defined by Workspace, by Country, or by Resource. A Workspace Holiday means that no Resources in the Workspace are working for that date. A Country Holiday means that no Resources in the Workspace located within the country are working for that date. A Resource Holiday means that the specified Resource is not working on that date.

Authentication

AuthorizationBearer

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

Headers

x-integration-namestringOptional
The name of the calling system passed along as a header parameter

Request

The information about the Holiday to create
reasonstringOptional

Reason or label for the holiday (for example, public holiday name or company shutdown).

dateFromstringOptionalformat: "date"

First calendar day of the holiday (inclusive).

dateTostringOptionalformat: "date"

Last calendar day of the holiday (inclusive). Must be on or after DateFrom.

resourceIdslist of strings or nullOptional

Resources this holiday applies to (people scope). Mutually exclusive with CountryId.

countryIdlist of strings or nullOptional

ISO 3166-1 alpha-2 country identifiers this holiday applies to (country scope). Mutually exclusive with ResourceIds.

Response

Success
errorobject or nullOptional
If the API call failed, this will contain information about the error that occurred.
successbooleanOptionalRead-only

True if the API call succeeded; false otherwise.

hasErrorbooleanOptionalRead-only
True if the API call failed.
statusCodeenumOptional
The HTTP code of the response.
datalist of objectsOptional
If the API call succeeded, this will contain the results.