Rippling: PATCH Job Code

← tand_aapi operations · Get started · OpenAPI downloads

Contract 2026-10-28 · Operation rippling.t_and_a_api.patch_job_codes_job_code_id

Provider route: PATCH /platform/api/job_codes/{job_code_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["tandAapi"]["patchJobCodesJobCodeId"]>[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.tandAapi.patchJobCodesJobCodeId(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.tand_aapi.patch_job_codes_job_code_id(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.job_code_id	string	Required within parent
body	object	Optional
body.dimension	string	Optional	The id of the dimension you’d like to update the job code to.
body.spoke_identifier	string	Optional	The new external identifier you’d like to update the job code to.
body.value	string	Optional	The new name you’d like to update the job code 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
$	Model	Root	Expand GET Job Code — response body

Referenced models: GET Job Code — response body

Policy, approvals and errors

SDK function policy ID: rippling.t_and_a_api.patch_job_codes_job_code_id. Catalog operation: t-and-a-api.patch-job_codes-job_code_id. 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