Creates a new absence region.

POST

Creates a new absence region. An absence region is defined by an ISO 3166-1 alpha-2 country code and a location code. There can be multiple absence regions for a country, but only one absence region for a country and location. (no duplicates)

Required Permissions: The user must be an admin or have user-planning-data:write permissions.

Request

This endpoint expects an object.
namestringRequired

The name of the absence region. Should be unique.

countryCodestringRequired

The ISO 3166-1 alpha-2 country code. (e.g. ‘DE’ for Germany)

locationCodestringOptional

The (optional) location code of the absence region. It is in ISO 3166-2 format. (e.g. ‘DE-BE’ for Berlin, Germany)

isDefaultbooleanOptional

Indicates whether the absence region is the default absence region. A default absence region is automatically assigned to new employees.

Response

Success

idstringOptional
createdOndatetimeOptional
createdBystringOptional
updatedOndatetimeOptional
updatedBystringOptional
namestringOptional

The name of the absence region, as specified by the user. It must be unique within the workspace.

countryCodestringOptional

The country code of the absence region. It must be a valid ISO 3166-1 alpha-2 country code.

countrystringOptional

The english name of the country.

locationCodestringOptional

The location code of the absence region. It is optional. It should be a valid ISO 3166-2 country subdivision code.

locationstringOptional

The name of the location. It will always be in the related country’s language.

isDefaultbooleanOptional

Indicates whether the absence region is the default absence region. Any new user will be assigned to the default absence region.

numberOfPublicHolidaysintegerOptional

The number of public holidays in the absence region.

assignedUserslist of stringsOptional

The list of user ids assigned to the absence region.