Rippling: POST Leave Request

← base_api operations · Get started · OpenAPI downloads

Contract 2026-10-28 · Operation rippling.base_api.post_leave_requests

Provider route: POST /platform/api/leave_requests. 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["baseApi"]["postLeaveRequests"]>[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.baseApi.postLeaveRequests(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.base_api.post_leave_requests(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	object	Optional
body.companyLeaveType	string	Required within parent	Unique identifier of the company leave type
body.endDate	string	Required within parent
body.endDateCustomHours	string	Optional
body.endDateEndTime	string	Optional
body.externalId	string	Optional	Object id for corresponding leave obejct in third party system. This may be null.
body.leavePolicy	string	Required within parent	Unique identifier of the leave policy. Required if request is not managed by TILT
body.managedBy	string	Optional	String identifier for third party that manages this leave request. This may be null.
body.reasonForLeave	string	Optional
body.requestedBy	string	Optional
body.role	string	Required within parent	Unique identifier of the employee who is taking leave.
body.startDate	string	Required within parent
body.startDateCustomHours	string	Optional
body.startDateStartTime	string	Optional
body.status	string	Optional	The status to create the leave request in. Only TILT managed requests can take a status other than PENDING.

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
$	JSON	Root
$ (anyOf 1)	Model	Alternative	Expand GET Leave Requests — response body — item
$ (anyOf 2)	array	Alternative
$ (anyOf 2)[]	Model	Each item	Expand GET Leave Requests — response body — item

Referenced models: GET Leave Requests — response body — item

Policy, approvals and errors

SDK function policy ID: rippling.base_api.post_leave_requests. Catalog operation: v1.post-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.

Official provider source