API v1 ReferenceAbsences

Creates a new absence.

User planning data permissions are required if the calling user is not the owner of the absence or admin. The startOn and endOn get rounded to 00:00:00, 12:00:00, or 23:59:59 in UTC. These values can be used to set a half-day (pre or post mid-day) absence, or absences that start or end at mid-day. The end date needs to be the same or after the start date.

Subscription Level
This endpoint requires the Standard plan or higher.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
userIdUUIDRequired
The id of the user to create the absence for.
startOndatetimeRequired
The start time of the absence. The time of the date will be ignored.
endOndatetimeRequired
The end time of the absence. The time of the date will be ignored.
descriptionstring or nullOptional>=0 characters<=1000 characters
The reason for the absence.
isHalfDayOnStartbooleanOptional
If it's true and it's a single day absence means that the absence to create 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 to create 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.
isSingleDayAbsencebooleanOptional

Response

OK
idUUID or null
createdOndatetime or null
createdByUUID or null
updatedOndatetime or null
updatedByUUID or null
userIdUUID or null
The id of the user to create the absence for.
startOndatetime or null
The start time of the absence.
endOndatetime or null
The end time of the absence.
descriptionstring or null
The reason for the absence.
externalProviderstring or null
The external provider for the absence.
deletedOndatetime or null
The date the absence was deleted.
deletedByUUID or null
The id of the user that deleted the absence.
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.