absences

Updates the specified absence.

Changed on

Updates the specified absence with dates rounded to 00:00:00, 12:00:00, or 23:59:59 UTC to support full-day and half-day periods. The end date must be the same as or later than the start date, and overlapping absences are rejected unless the provider allows them.

         Web and mobile requests cannot update absences managed by an external provider.
         <Check title="Required Permissions" icon="key">The user must own the absence, be an admin, or have `user-planning-data:write` permission.</Check>
put/absences/{absenceId}

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/absences/{absenceId}
  • Auth: HTTP bearer

Path parameters

absenceIdstring uuid required

The id of the absence to update.

Request body

userIdstring uuid required

The id of the user to create the absence for.

startOnstring date-time

The start time of the absence. The time of the date will be ignored.

endOnstring date-time

The end time of the absence. The time of the date will be ignored.

descriptionstring nullable

The reason for the absence.

externalProviderstring nullable

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.

isHalfDayOnStartboolean

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.

isHalfDayOnEndboolean

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.

isSingleDayAbsenceboolean

Response

OK

idstring uuid

The id of the entity.

createdOnstring date-time

The date this entity was created.

createdBystring uuid

The id of the user who created this entity.

updatedOnstring date-time

The date this entity was last modified.

updatedBystring uuid

The id of the user who last modified this entity.

userIdstring uuid nullable

The id of the user to create the absence for.

startOnstring date-time

The start time of the absence.

endOnstring date-time

The end time of the absence.

descriptionstring nullable

The reason for the absence.

externalProviderstring nullable

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.

deletedOnstring date-time nullable

The date the absence was deleted.

deletedBystring uuid nullable

The id of the user that deleted the absence.

isReadOnlyboolean

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

isHalfDayOnStartboolean

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

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.

Changes

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e46cf415581Revision changes
    • info

      api operation id PutAbsenceById removed and replaced with absences_PutAbsenceById