Creates a new absence region.
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)
Subscription Level
This endpoint requires the Standard plan or higher.Required Permissions
The user must be an admin or haveuser-planning-data:write
permissions.Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
This endpoint expects an object.
name
The name of the absence region. Should be unique.
countryCode
The ISO 3166-1 alpha-2 country code. (e.g. ‘DE’ for Germany)
locationCode
The (optional) location code of the absence region. It is in ISO 3166-2 format. (e.g. ‘DE-BE’ for Berlin, Germany)
isDefault
Indicates whether the absence region is the default absence region.
A default absence region is automatically assigned to new employees.
Response
OK
id
createdOn
createdBy
updatedOn
updatedBy
name
The name of the absence region, as specified by the user.
It must be unique within the workspace.
countryCode
The country code of the absence region. It must be a valid ISO 3166-1 alpha-2 country code.
country
The english name of the country.
locationCode
The location code of the absence region. It is optional. It should be a valid ISO 3166-2 country subdivision code.
location
The name of the location.
It will always be in the related country's language.
isDefault
Indicates whether the absence region is the default absence region.
Any new user will be assigned to the default absence region.
numberOfPublicHolidays
The number of public holidays in the absence region.
assignedUsers
The list of user ids assigned to the absence region.