Sign in
Absences

Create an absence

Create a new absence record for a resource (required scope resources:write)

post/v1/absences

Headers

Customer-Idinteger required

The customer identifier

Request body

resourceIdinteger required

The unique identifier of the resource the absence is for

startAtstring date-time required

The date and time the absence starts

endAtstring date-time required

The date and time the absence ends. Must be on or after StartAt

absenceTypeIdinteger required

The unique identifier of the absence type. Must reference a valid absence type for this customer

daysRequestednumber double nullable

The number of days requested for the absence

reasonstring nullable

Free-text reason for the absence

isPaidLeaveboolean nullable

Whether this absence is paid leave

Example request

{
  "resourceId": 12345,
  "startAt": "2026-01-01T00:00:00.0000000+00:00",
  "endAt": "2026-01-02T00:00:00.0000000+00:00",
  "absenceTypeId": 1,
  "daysRequested": 1,
  "reason": "Annual leave"
}

Response

Created

idinteger

Identifier of the newly created record

Changes

Changed in 1 of the 3 revisions of this API.1