Rippling: Create or update a custom object record

← rest_api operations · Get started · OpenAPI downloads

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

Provider route: POST /custom-objects/{custom_object_api_name}/records/. 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"]["createCustomObjectsCustomObjectApiNameRecords"]>[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.createCustomObjectsCustomObjectApiNameRecords(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.create_custom_objects_custom_object_api_name_records(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.custom_object_api_name	string	Required within parent
body	object	Optional	An object containing field values for the custom object record. A new external_id creates a record; an existing external_id updates that record. Use a stable, source-derived external_id to make retries resolve to the same record. Additional keys: allowed
body.external_id	string	Optional	A caller-provided identifier that creates a record when new and updates the existing record when reused.

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
data	JSON	Optional
data (anyOf 1)	Model	Alternative	Expand Update a custom object record — response body — data created at, id, name, updated at
data (anyOf 2)	object	Alternative	A write receipt returned when the record is not visible to the caller’s read permissions. Additional keys: not allowed
data (anyOf 2).id	JSON	Required within parent

Referenced models: Update a custom object record — response body — data created at, id, name, updated at

Policy, approvals and errors

SDK function policy ID: rippling.rest_api.create_custom_objects_custom_object_api_name_records. Catalog operation: create-custom-objects/(custom-object-api-name)/records. 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: ["custom-object-records.read-write", "custom-objects.read-write.owner"]

Provider entitlements: ["API_Tier_1"]

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

Official provider source