Time Off

Update Time Off

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.

Authentication

This endpoint accepts any one of the following token types:

Company-scoped access token (OAuth2AuthorizationCode) — obtained by a company manager through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
Company-scoped access token (assertion) (OAuth2CompanyManagerAssertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant for a company manager. See OAuth Assertion.
Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page, with the scopes they choose there. See Authorization for customers.

Scopes

Any one of the scopes in a token type's row is enough. all:write works too.

Token type	Category	Read only Scope	Write only Scope (read access implicit)
Company-scoped access token	Manage timeoffs (time_and_attendance)	-	Manage timeoffs (timeoff:write)
Company-scoped access token (assertion)	Manage timeoffs (time_and_attendance)	-	Manage timeoffs (timeoff:write)
Customer API token	Manage timeoffs (time_and_attendance)	-	Manage timeoffs (timeoff:write)

patch/v1/timeoff/{id}

Request

Base URL
https://gateway.remote.com
URL
https://gateway.remote.com/v1/timeoff/{id}
Auth
- OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: https://gateway.remote.com/company.manage
- or OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: timeoff:write
- or OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: all:write
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: timeoff:write
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: all:write
- or HTTP bearer

Path parameters

idstring required

Timeoff ID

Headers

Authorizationstring required

An access token of one of the types listed in this endpoint's Authentication section, as Bearer <ACCESS TOKEN>.

A token from the Refresh Token flow is of the same type as the token issued with that refresh token.

Request body

approved_atstring date-time

UTC date time in ISO 8601 format.

approver_idstring nullable

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_reasonstring required

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

edit_reasonstring required

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

end_datestring date

UTC date in ISO 8601 format

notesstring

start_datestring date

UTC date in ISO 8601 format

status'approved' | 'cancelled'

timezonestring

TZ identifier

Example request

{
  "cancel_reason": "Some cancel reason",
  "edit_reason": "Some edit reason"
}

Response

Success

Example response

{
  "data": {
    "timeoff": {
      "automatic": false,
      "document": {
        "id": "9880b711-file-id-ecf8f551bd78",
        "inserted_at": "2021-07-15T18:18:17Z",
        "name": "id.pdf",
        "sub_type": "personal_id",
        "type": "id"
      },
      "employment_id": "5e55386e-4f4f-4def-92f4-bdc19a5ce77d",
      "end_date": "2021-12-21",
      "id": "0073fcb5-b669-4e4a-b963-2a47744e75a1",
      "leave_policy": {
        "leave_policy_variant_slug": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
        "leave_type": "sick_leave",
        "name": "Self-Care"
      },
      "notes": "Some notes",
      "start_date": "2021-12-20",
      "status": "approved",
      "timeoff_days": [
        {
          "day": "2021-12-20",
          "hours": 8,
          "minutes": 480
        },
        {
          "day": "2021-12-21",
          "hours": 8,
          "minutes": 480
        }
      ],
      "timeoff_type": "paid_time_off",
      "timezone": "Asia/Kolkata",
      "total_minutes": 960
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.