Rippling: Update a site

← rest_api operations · Get started · OpenAPI downloads

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

Provider route: PATCH /sites/{api_name}/. 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"]["updateSites"]>[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.updateSites(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_sites(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.api_name	string	Required within parent
body	Model	Optional	Expand Update a site — request body — body

Referenced models: Update a site — 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	Response/resource shape for a custom site.
admin_group_id	string	Optional	The admin group id for the custom site
api_name	string	Optional	The unique api name of the custom site
created_at	string	Optional	Record creation date
created_by	string	Optional	The ID of the role that created the custom site
current_bundle_id	string	Optional	The active bundle id for the custom site
description	string	Optional	The optional description of the custom site
id	string	Optional	Identifier field
logo	string	Optional	A Rippling-owned logo URL for the custom site
name	string	Optional	The display name of the custom site
viewer_group_id	string	Optional	The viewer group id for the custom site

Policy, approvals and errors

SDK function policy ID: rippling.rest_api.update_sites. Catalog operation: update-sites. 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: ["sites.read-write"]

Provider entitlements: ["Sites_Platform_API"]

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

Official provider source