API v1 ReferenceAbsences

Creates an absence.

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. <Check title="Required Permissions" icon="key">User planning data permissions are required if the calling user is not the owner of the absence or admin.</Check> <Note title="Subscription Level" icon="layer-group">This endpoint requires the `Standard` plan or higher.</Note>

Authentication

AuthorizationBearer

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

Request

The model to create the absence.
userIdstringRequiredformat: "uuid"
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 nullOptional0-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.

Response

OK
idstring or nullformat: "uuid"
The id of the entity.
createdOndatetime or null
The date this entity was created.
createdBystring or nullformat: "uuid"
The id of the user who created this entity.
updatedOndatetime or null
The date this entity was last modified.
updatedBystring or nullformat: "uuid"
The id of the user who last modified this entity.
userIdstring or nullformat: "uuid"
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.
deletedBystring or nullformat: "uuid"
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.

Errors