Rippling: Start a package version component update

← rest_api operations · Get started · OpenAPI downloads

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

Provider route: POST /package-version-component-updates/. 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"]["updatePackageVersionComponentUpdates"]>[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.updatePackageVersionComponentUpdates(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_package_version_component_updates(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.action	string	Required within parent	The update action to perform. One of: ADD, REMOVE, REFRESH
body.is_preview_mode	boolean	Optional	When true, compute the component diff without persisting the version. When false, apply and save the changes. Same tracker contract in both modes. Default: false
body.nodes	array	Optional	Component identifiers required for ADD and REMOVE.
body.nodes[]	object	Each item
body.version_id	string	Required within parent	The draft package version to update.

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 package version component-update tracker for publisher companies.
created_at	string	Required within parent	Record creation date
error_message	string	Optional	Error message when the update failed
extraction_result	object	Optional	Diff of added, removed, and updated nodes when status is COMPLETE. In preview mode this is what would change; in apply mode this is what did change. Null while the update is in progress.
id	string	Required within parent	Identifier field
package_version_id	string	Optional	The package version being updated
status	string	Optional	Update status (IN_PROGRESS, COMPLETE, or FAILED)
updated_at	string	Required within parent	Record update date

Policy, approvals and errors

SDK function policy ID: rippling.rest_api.update_package_version_component_updates. Catalog operation: update-package-version-component-updates. 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.read-write"]

Provider entitlements: ["Unity_Packages_V2_Platform_API"]

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

Official provider source