Updates the absence with the specified id.

PUT

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.

Path parameters

absenceIdstringRequired

The id of the absence to update.

Request

This endpoint expects an object.
userIdstringRequired

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.

descriptionstringOptional>=0 characters<=1000 characters

The reason for the absence.

externalProviderstringOptional>=0 characters<=100 characters

The external provider for the absence.

isHalfDayOnStartbooleanOptionalDefaults to false

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.

isHalfDayOnEndbooleanOptionalDefaults to false

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.

isSingleDayAbsencebooleanOptionalDefaults to false

Response

OK

idstringOptional
createdOndatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z
createdBystringOptional
updatedOndatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z
updatedBystringOptional
userIdstringOptional

The id of the user to create the absence for.

startOndatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

The start time of the absence.

endOndatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

The end time of the absence.

descriptionstringOptional

The reason for the absence.

externalProviderstringOptional

The external provider for the absence.

deletedOndatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

The date the absence was deleted.

deletedBystringOptional

The id of the user that deleted the absence.

isReadOnlybooleanOptionalDefaults to false

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

isHalfDayOnStartbooleanOptionalDefaults to false

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.

isHalfDayOnEndbooleanOptionalDefaults to false

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.

Built with