Rippling: Update a custom object field

← rest_api operations · Get started · OpenAPI downloads

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

Provider route: PATCH /custom-objects/{custom_object_api_name}/fields/{field_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"]["updateCustomObjectsCustomObjectApiNameFields"]>[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.updateCustomObjectsCustomObjectApiNameFields(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_custom_objects_custom_object_api_name_fields(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
path.field_api_name	string	Required within parent
body	object	Optional
body.data_type	object	Optional	The data type configuration for the field. Additional keys: allowed
body.data_type.num_of_decimal_places	integer	Optional	Configured fractional scale for NUMBER, PERCENTAGE, and CURRENCY fields. Availability above the legacy per-type limit is capability-gated. Maximum: 15 Minimum: 0
body.derived_field_formula	string	Optional	The formula for derived fields.
body.description	string	Optional	A description of the field.
body.enable_history	boolean	Optional	Whether to track history for this field.
body.formula_attr_metas	object	Optional	Metadata for formula attributes.
body.is_unique	boolean	Optional	Whether field values must be unique.
body.name	string	Optional	The name of the field.
body.name_field_details	object	Optional	Configuration for name field display.
body.required	boolean	Optional	Whether this field is required.
body.rql_definition	object	Optional	The RQL definition for computed fields.
body.section	object	Optional	The section configuration for the field.

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
api_name	string	Required within parent	The api name of the custom object field
created_at	string	Required within parent	Record creation date
custom_object	string	Required within parent	The custom object which the field belongs to
data_type	object	Required within parent	The data type configuration for the field. Additional keys: allowed
data_type.num_of_decimal_places	JSON	Optional
data_type.num_of_decimal_places (anyOf 1)	integer	Alternative	Configured fractional scale for NUMBER, PERCENTAGE, and CURRENCY fields. Availability above the legacy per-type limit is capability-gated. Maximum: 15 Minimum: 0
data_type.num_of_decimal_places (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
description	string	Optional	The description of the custom object field
enable_history	boolean	Required within parent	whether the history is enable for the field
id	string	Required within parent	Identifier field
is_immutable	boolean	Required within parent	whether the field is imuatable
is_standard	boolean	Required within parent	whether the field is standard field
is_unique	boolean	Required within parent	This field specifies whether a particular column value has unique values
managed_package_install_id	string	Optional	The id of the package which the custom object field belongs to
name	string	Required within parent	The name of the custom object field
updated_at	string	Required within parent	Record update date

Policy, approvals and errors

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

Provider entitlements: ["API_Tier_1"]

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

Official provider source