API v1 ReferenceWorkspace Absences

Creates a new workspace absence.

Creates a new workspace absence. A workspace absence is a kind of absence that is applied to all users in a workspace. It can be used to define special holidays (e.g: company offsite) that apply to all users in a workspace. It can be limited to a specific absence region, in which case only users in that region will be affected.

Subscription Level
This endpoint requires the Standard plan or higher.
Required Permissions
The user must be an admin or have user-planning-data:write permissions.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
startOndatetimeRequired

The start time of the workspace absence.

endOndatetimeRequired

The end time of the workspace absence.

descriptionstringRequired>=0 characters<=1000 characters

The description of the workspace absence.

regionIdUUID or nullOptional

(optional) The id of the absence region to limit the workspace absence to. If not set, the workspace absence will apply to all users in the workspace. Otherwise, it will only apply to users in the specified absence region.

isHalfDayOnStartbooleanOptional

If it’s true, and it’s a single day absence means that the absence is for the first half of the workday. If it’s a multi day absence, it will start on the second half of the first day of the absence period.

isHalfDayOnEndbooleanOptional

If it’s true, and it’s a single day absence means that the absence is for the second half of the workday. If it’s a multi day absence it will end on the first half of the last day of the absence period.

Response

OK

idUUIDOptional
createdOndatetimeOptional
createdByUUIDOptional
updatedOndatetimeOptional
updatedByUUIDOptional
startOndatetimeOptional

The start time of the workspace absence.

endOndatetimeOptional

The end time of the workspace absence.

descriptionstring or nullOptional

The description of the absence.

regionIdUUID or nullOptional

The (optional) regionId of the workspace absence. If null, the absence is global for the entire workspace. Otherwise, it will be applied only to the users of the region.

regionstring or nullOptional

The name of the region of the workspace absence. Null if the absence is global for the entire workspace.

isReadOnlybooleanOptional

If it’s true it means that this Absence is read-only and cannot be edited/deleted by the user.

isHalfDayOnStartbooleanOptional

If it’s true and it’s a single day absence means that the absence is for the first half of the workday. If it’s a multi day absence it started on the second half of the first day of the absence period.

isHalfDayOnEndbooleanOptional

If it’s true and it’s a single day absence means that the absence is for the second half of the workday. If it’s a multi day absence it ended on the first half of the last day of the absence period.