Update Time Off

patch

https://gateway.remote.com/v1/timeoff/{id}

Updates a Time Off record. Warning: Updating the status of a time off through this endpoint is deprecated and will be removed on January 13, 2025. To approve or cancel an approved time off, use the /approve and /cancel endpoints instead.

Scopes

Category	Read only Scope	Write only Scope (read access implicit)
Manage timeoffs (`time_and_attendance`)	-	Manage timeoffs (`timeoff:write`)

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Timeoff ID

Body Params

UpdateTimeoff

approved_at

date-time

UTC date time in ISO 8601 format.

approver_id

string | null

The field matches the id of a user in the Remote Platform that has permission to approve time off requests. Available users can be found fetching the List Company Manager endpoint.

cancel_reason

string

required

The reason for cancelling a time off. Required when updating to status cancelled.

document

object

Timeoff document params

edit_reason

string

required

The reason for the update. Required when updating the time off data but not changing the status.

end_date

date

UTC date in ISO 8601 format

notes

string

start_date

date

UTC date in ISO 8601 format

status

string

enum

deprecated

Allowed:

timeoff_days

array of objects

timeoff_days

timeoff_type

string

enum

timezone

string

TZ identifier

Headers

Authorization

string

required

Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow.

The refresh token needs to have been obtained through the Authorization Code flow.

Responses

Callback

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Bad Request

401Unauthorized

404Not Found

422Unprocessable Entity

429Unprocessable Entity