Rippling: Update a custom object list view
Rippling restApi.partialUpdateCustomObjectListView: arguments, response, policy and SDK examples.
← Rest API operations · Get started
Operation rippling.rest_api.partial_update_custom_object_list_view
Provider route: PATCH /custom-objects/{custom_object_api_name}/list-views/{view_api_name}/. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “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"]["partialUpdateCustomObjectListView"]>[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.partialUpdateCustomObjectListView(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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.partial_update_custom_object_list_view(arguments) result = await call.wait() return result.body_json()| 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.view_api_name | string | Required within parent | |
body | Model | Required within parent | Expand Update a custom object list view — request body — body |
Referenced models: Update a custom object list view — request body — body
Response
Section titled “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 Create a custom object list view — response body |
Referenced models: Create a custom object list view — response body
Schemas
Section titled “Schemas”Create a custom object list view — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A saved grid definition, including its RQL predicate, for retrieval, editing, or duplication. |
api_name | string | Required within parent | Stable API name used to address this view. |
capabilities | Model | Required within parent | Expand Create a custom object list view — response body — capabilities |
columns | array | Required within parent | Visible columns, in saved display order. |
columns[] | Model | Each item | Expand Create a custom object list view — response body — columns item |
created_at | string | Required within parent | Time the view was created, as an ISO 8601 timestamp in UTC. Format: date-time |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Creator-provided explanation of the records or purpose of this saved view. Null when no explanation was saved. |
description (anyOf 2) | null | Alternative | |
has_filter | boolean | Required within parent | Whether this view applies a saved filter in addition to record_scope. The server resolves it when view_api_name is supplied to record queries. |
id | string | Required within parent | Read-only internal identifier; address operations using api_name. |
is_default | boolean | Required within parent | Whether this is the company's default view for this object. |
name | string | Required within parent | Display name of the saved view. |
order_by | JSON | Optional | |
order_by (anyOf 1) | string | Alternative | Saved ordering as one field API name, a space, and lowercase asc or desc, for example name asc. Null means no saved ordering. |
order_by (anyOf 2) | null | Alternative | |
query | JSON | Optional | |
query (anyOf 1) | string | Alternative | Saved RQL predicate, excluding record scope. Null when no predicate is saved. |
query (anyOf 2) | null | Alternative | |
record_scope | string | Required within parent | MY_RECORDS restricts owners to the authenticated requester when the view is used. Known values: ALL, MY_RECORDS |
updated_at | string | Required within parent | Time the view was last updated, as an ISO 8601 timestamp in UTC. Format: date-time |
visibility | string | Required within parent | PRIVATE belongs to its creator; SHARED is visible within the company. Neither grants record access. Known values: PRIVATE, SHARED |
Referenced models: Create a custom object list view — response body — columns item, Create a custom object list view — response body — capabilities
Update a custom object list view — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Changes to a saved grid definition; omitted properties retain their saved values. Minimum fields: 1 Additional keys: not allowed |
columns | array | Optional | Ordered, nonempty, unique field selection. |
columns[] | Model | Each item | Expand Create a custom object list view — request body — body columns item |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Creator-provided explanation of the records or purpose of this saved view. Null clears the explanation; omission preserves it. |
description (anyOf 2) | null | Alternative | |
name | string | Optional | Nonblank display name. |
order_by | JSON | Optional | |
order_by (anyOf 1) | string | Alternative | One sortable field API name, a space, and lowercase asc or desc, for example name asc. Null clears saved ordering. |
order_by (anyOf 2) | null | Alternative | |
query | JSON | Optional | |
query (anyOf 1) | string | Alternative | Saved RQL predicate; null clears it. |
query (anyOf 2) | null | Alternative | |
record_scope | string | Optional | ALL includes all records the caller may read; MY_RECORDS restricts owners to the authenticated requester when the view is used. Omission preserves the saved scope. One of: ALL, MY_RECORDS |
visibility | string | Optional | PRIVATE belongs to its creator; SHARED is visible within the company. Neither grants record access. Shared views cannot become private. Omission preserves visibility. One of: PRIVATE, SHARED |
Referenced models: Create a custom object list view — request body — body columns item
Create a custom object list view — response body — columns item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A visible field within a Custom Object list view. |
field | string | Required within parent | Field API name. |
Create a custom object list view — response body — capabilities
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Actions available to this caller. |
can_delete | boolean | Required within parent | Whether the caller may delete this view. |
can_duplicate | boolean | Required within parent | Whether the caller may create a copy of this definition. |
can_set_default | boolean | Required within parent | Whether the caller may make this view the company default. |
can_share | boolean | Required within parent | Whether the caller may make this private view shared. |
can_update | boolean | Required within parent | Whether the caller may edit this view. |
Create a custom object list view — request body — body columns item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A field selected for display at its position in a saved grid's ordered columns. Additional keys: not allowed |
field | string | Required within parent | Field API name. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: rippling.rest_api.partial_update_custom_object_list_view. Catalog operation: partial-update-custom-object-list-view. 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", "custom-objects.read-write", "custom-objects.read-write.owner"]
Provider entitlements: ["Internal_Testing"]
Pinned headers: {"Rippling-Api-Version": "2024-08-01"}