Delete or cancel an absence

Operation ID: deleteAbsence

Group: People Management › Absences

Open in the interactive reference

DELETE /people/absences/{id}

Retry-safe: A write that accepts Idempotency-Key: repeating a request with the same key replays the stored answer instead of executing twice.

Deletes or cancels an absence. Deleting does not always remove the absence. An absence with status 'requested' is removed.

Any other approved or rejected absence is canceled instead: its status changes to 'canceled' and the absence is kept. An absence that is already canceled stays as it is.

An absence created from a mandatory absence, which the company assigns to employees, can be deleted only by an HR administrator who is not its employee, and is then removed whatever its status. Unless you are an HR administrator or the employee's manager, you can't delete an approved absence that has already started.

When the request succeeds, it returns the id whether the absence was removed, canceled, or left as it was. To see what happened, read the absence with GET people/absences/:id.

Parameters

Name In Type Required Description
Api-Version header string · v1 yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
Idempotency-Key header string no An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with 400 IDEMPOTENCY_NOT_SUPPORTED rather than silently ignored.
id path string yes The unique identifier of the absence you want to delete.

Response

200 Success

Under data (deleteAbsenceOutput):

Field Type Required Description
id string yes The unique identifier for the deleted absence. 
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Response headers

Errors

Code Status
NOT_FOUND 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses