Rippling: Update a leave request

← rest_api operations · Get started · OpenAPI downloads

Contract 2026-10-28 · Operation rippling.rest_api.update_leave_requests

Provider route: PATCH /leave-requests/{id}/. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/rippling with npm, or alter-sdk-rippling with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { RipplingIntegration } from "@alter-ai/rippling";

async function execute(input: Parameters<RipplingIntegration["restApi"]["updateLeaveRequests"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new RipplingIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.restApi.updateLeaveRequests(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_rippling import RipplingIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = RipplingIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.rest_api.update_leave_requests(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.id	string	Required within parent	Format: id
body	Model	Optional	Expand Update a leave request — request body — body

Referenced models: Update a leave request — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	object	Root
comments	string	Optional	The comments associated with the leave request.
created_at	string	Required within parent	Record creation date
days_take_off	array	Optional	The specific dates taken off and the amount of time taken off for each one.
days_take_off[]	Model	Each item	Expand Update a leave request — response body — days take off item
end_date	string	Required within parent	The end date of the leave request.
end_time	string	Optional	The end time of the leave request.
id	string	Required within parent	Identifier field
is_managed_by_external_system	boolean	Optional	Whether the leave request is managed by an external system.
leave_event_id	string	Optional	The ID of the leave event associated with the leave request, if any.
leave_policy_id	string	Optional	The ID of the leave policy associated with the leave request, either leave_policy_id or leave_type_id must be provided.
leave_type	Model	Optional	Expand Update a leave request — response body — leave type
leave_type_id	string	Optional	The ID of the leave type associated with the leave request, either leave_policy_id or leave_type_id must be provided.
number_of_minutes_requested	JSON	Optional
number_of_minutes_requested (anyOf 1)	number	Alternative	The number of minutes requested for the leave request.
number_of_minutes_requested (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
reason_for_leave	string	Optional	The reason for the leave request.
requester	Model	Optional	Expand Update a leave request — response body — requester
requester_id	string	Optional	The ID of the worker who requested the leave request.
reviewed_at	string	Optional	The timestamp of when the leave request was reviewed.
reviewer	Model	Optional	Expand Update a leave request — response body — reviewer
reviewer_id	string	Optional	The ID of the worker who reviewed the leave request.
start_date	string	Required within parent	The start date of the leave request.
start_time	string	Optional	The start time of the leave request.
status	string	Required within parent	The status of the leave request. Known values: PENDING, APPROVED, REJECTED, CANCELED
updated_at	string	Required within parent	Record update date
worker	Model	Optional	Expand Update a leave request — response body — worker
worker_id	string	Required within parent	The ID of the worker associated with the leave request.

Referenced models: Update a leave request — response body — days take off item, Update a leave request — response body — leave type, Update a leave request — response body — requester, Update a leave request — response body — reviewer, Update a leave request — response body — worker

Policy, approvals and errors

SDK function policy ID: rippling.rest_api.update_leave_requests. Catalog operation: update-leave-requests. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["leave-requests.read-write"]

Provider entitlements: ["API_Tier_1"]

Pinned headers: {"Rippling-Api-Version": "2024-08-01"}

Official provider source