API v1 ReferenceAbsences

Updates the absence with the specified id.

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>

Authentication

AuthorizationBearer

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

Path parameters

absenceIdstringRequiredformat: "uuid"
The id of the absence to update.

Request

The model to update the absence.
userIdstringRequiredformat: "uuid"
The id of the user to create the absence for.
startOndatetimeOptional
The start time of the absence. The time of the date will be ignored.
endOndatetimeOptional
The end time of the absence. The time of the date will be ignored.
descriptionstring or nullOptional0-1000 characters
The reason for the absence.
externalProviderstring or nullOptional0-100 characters

The external provider for the absence. If this value is set, the absence is treated as externally managed and therefore read-only in awork. This means users in awork can no longer edit or delete 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
idstringformat: "uuid"
The id of the entity.
createdOndatetime
The date this entity was created.
createdBystringformat: "uuid"
The id of the user who created this entity.
updatedOndatetime
The date this entity was last modified.
updatedBystringformat: "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
The start time of the absence.
endOndatetime
The end time of the absence.
descriptionstring or null
The reason for the absence.
externalProviderstring or null

The external provider for the absence. If this value is set, the absence is treated as externally managed and therefore read-only in awork. This means users in awork can no longer edit or delete the absence.

deletedOndatetime or null
The date the absence was deleted.
deletedBystring or nullformat: "uuid"
The id of the user that deleted the absence.
isReadOnlybooleanRead-only

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

isHalfDayOnStartbooleanRead-only
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.
isHalfDayOnEndbooleanRead-only
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

400
Bad Request Error
401
Unauthorized Error