Absence

Changed on
put/v4/absences/{id}

Request

  • Base URL
    https://my.clockodo.com/api
  • URL
    https://my.clockodo.com/api/v4/absences/{id}
  • Auth
    • HTTP basic and API key in header X-Clockodo-External-Application
    • or API key in header X-ClockodoApiUser and API key in header X-ClockodoApiKey and API key in header X-Clockodo-External-Application
    • or OAuth 2
      Authorization code: /oauth/authorize
      Token URL: /token

Path parameters

idinteger required
Example:1

Request body

date_sincestring date
date_untilstring date
type1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15

Possible values:

  • 1: Holiday from the quota
  • 2: Special leaves
  • 3: Reduction of overtime
  • 4: Sick day
  • 5: Sick day of a child
  • 6: School / further education
  • 7: Maternity protection
  • 8: Home office (planned hours get applied)
  • 9: Work out of office (planned hours get applied)
  • 10: Special leaves (unpaid)
  • 11: Sick day (unpaid)
  • 12: Sick day of a child (unpaid)
  • 13: Quarantine (work not possible)
  • 14: Military / alternative service
  • 15: Sick day (sickness benefit)
half_dayboolean
count_hoursnumber float nullable
allow_overrideinteger[]

IDs of absences that may be shortened or deleted to avoid conflicts

status0 | 1 | 2 | 3 | 4

Possible values:

  • 0: Enquired
  • 1: Approved
  • 2: Declined
  • 3: ApprovalCancelled
  • 4: Cancelled
sick_noteboolean
notestring nullable
public_notestring nullable
mail_approval_tokenstring

Token from the approval link of the request mail. If given, the update is rejected unless the token belongs to this absence in its current state and to the current user.

Example request

{
  "date_since": "2023-02-28",
  "date_until": "2023-02-28"
}

Response

Successful operation

Changes

  • c84da07d7eb7Revision changes
    • info

      added the new optional request property

  • a88d0ed986cfRevision changes
    • breaking

      removed the required property ///// from the response with the status

    • warning

      added the new AbsenceCollision enum value to the //// response property for the response status

    • warning

      added the new AbsenceHasToBeDeclined enum value to the //// response property for the response status

    • warning

      added the new CannotManageAbsencesOfUser enum value to the //// response property for the response status

    • warning

      added the new Empty enum value to the //// response property for the response status

    • warning

      added the new FieldsShouldBeEmpty enum value to the //// response property for the response status

    • warning

      added the new HalfDayAbsenceTooLong enum value to the //// response property for the response status

    • warning

      added the new StatusIsForbidden enum value to the //// response property for the response status

    • warning

      added the new UntilBeforeSinceIsForbidden enum value to the //// response property for the response status

    • warning

      added the new UntilMustBeInSameYear enum value to the //// response property for the response status

    • info

      removed from the // response property anyOf list for the response status

    • info

      added the required property ///// to the response with the status