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. <Info title="Subscription Level">This endpoint requires the Standard plan or higher.</Info> <Check title="Required Permissions">The user must be an admin or have `user-planning-data:write` permissions.</Check>

Headers

AuthorizationstringRequired

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

Request

The model to create the workspace absence.
startOnstringRequiredformat: "date-time"
The start time of the workspace absence.
endOnstringRequiredformat: "date-time"
The end time of the workspace absence.
descriptionstringRequired>=0 characters<=1000 characters
The description of the workspace absence.
regionIdstring or nullOptionalformat: "uuid"

(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
idstring or nullformat: "uuid"
createdOnstring or nullformat: "date-time"
createdBystring or nullformat: "uuid"
updatedOnstring or nullformat: "date-time"
updatedBystring or nullformat: "uuid"
startOnstring or nullformat: "date-time"
The start time of the workspace absence.
endOnstring or nullformat: "date-time"
The end time of the workspace absence.
descriptionstring or null
The description of the absence.
regionIdstring or nullformat: "uuid"

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 null
The name of the region of the workspace absence. Null if the absence is global for the entire workspace.
isReadOnlyboolean or null

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

isHalfDayOnStartboolean or null
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.
isHalfDayOnEndboolean or null
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.