Rippling: Start a package upgrade

← rest_api operations · Get started · OpenAPI downloads

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

Provider route: POST /package-upgrades/. 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"]["upgradePackageUpgrades"]>[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.upgradePackageUpgrades(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.upgrade_package_upgrades(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.install_key	string	Required within parent	The install key of the managed package install to upgrade.
body.package_key	string	Required within parent	The package key of the managed package to upgrade.
body.version_id	string	Required within parent	The published package version to upgrade to.

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	Async managed package upgrade tracker for subscriber companies.
created_at	string	Required within parent	Record creation date
error_message	string	Optional	Error message when upgrade failed
id	string	Required within parent	Identifier field
install_key	string	Optional	The install key of the managed package install
new_version_id	string	Optional	The published package version being upgraded to
old_version_id	string	Optional	The currently installed package version being upgraded from
package_key	string	Optional	The package key of the managed package
post_install_landing_component	object	Optional	Component to open after upgrade completes
status	string	Optional	Upgrade status (IN_PROGRESS, COMPLETE, or FAILED)
updated_at	string	Required within parent	Record update date
upgrade_plan	object	Optional	Upgrade plan snapshot when available
upgraded_components	array	Optional	Components upgraded so far
upgraded_components[]	JSON	Each item	Additional keys: see wildcard field
upgraded_components[].*	JSON	Additional keys

Policy, approvals and errors

SDK function policy ID: rippling.rest_api.upgrade_package_upgrades. Catalog operation: upgrade-package-upgrades. 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: ["packages-install.read-write"]

Provider entitlements: ["Unity_Packages_V2_Platform_API"]

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

Official provider source