Update Time Off Request

Updates an existing time off request using JSON Merge Patch semantics: only the fields present in the body are changed, and employeeNote may be set to null to clear it. Accepts both application/merge-patch+json and application/json.

Editing a request whose status is REQUESTED replaces the stored request and restarts its approval workflow, so the id in the response differs from the id in the path. That id is authoritative and should replace any id the client is holding; the id that was replaced returns 410 from then on. requestedAt is carried over from the replaced request, and editing a request whose status is APPROVED updates it in place, so id and requestedAt are both unchanged in that case.

Changing startDate or endDate requires sending dailyAmounts in the same request, so the per-day breakdown always covers the stored range. Omitting it returns 422; the server does not redistribute amounts on the caller's behalf.

OAuth Scopes: time_off:requests.write

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

The time off request ID.

Query Params
boolean
Defaults to false

Set to true to include the _links block naming the state transitions available to the caller for this time off request. Also accepts 1, yes and on. Omitted from the response by default.

Body Params

Data contract for partially updating a time off request. All fields are optional; only fields present in the request body are updated. Supplying employeeNote as null clears it.

integer

The id of the time off category for the request.

date

The date the time off starts, in ISO 8601 format (YYYY-MM-DD).

date

The date the time off ends (inclusive), in ISO 8601 format (YYYY-MM-DD).

length ≤ 1024

A note from the requester. Pass null to clear it. Maximum 1024 characters.

dailyAmounts
array of objects

The per-day amounts of time off requested, each within the request date range. Replaces the existing breakdown entirely, and restates the total amount with it. Required whenever startDate or endDate changes.

dailyAmounts
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/merge-patch+json

Generated from available request content types

Allowed:
Responses

Language
Credentials
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json