Zoho: Custom View update

← Custom views operations · Get started

Operation zoho.updatecustomview

Provider route: PUT /crm/v8/settings/custom_views/{id}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/zoho with npm, or alter-sdk-zoho with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { ZohoIntegration } from "@alter-ai/zoho";

async function execute(input: Parameters<ZohoIntegration["customViews"]["updateCustomView"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new ZohoIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.customViews.updateCustomView(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_zoho import ZohoIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = ZohoIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.custom_views.update_custom_view(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.id	string	Required within parent	Format: int64 Maximum length: 25
query	object	Required within parent	Additional keys: not allowed
query.module	string	Required within parent	Maximum length: 25
body	object	Required within parent	Represents the request body envelope for updating a specific Custom View by its ID. Additional keys: not allowed
body.custom_views	array	Required within parent	Specify the list of Custom View configurations to update. Maximum items: 1
body.custom_views[]	Model	Each item	Expand Custom View update — request body — body custom views item

Referenced models: Custom View update — request body — body custom views item

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 Sort Order by ID — response body

Referenced models: Sort Order by ID — response body

Schemas

17 more schemas are linked from the tables above, on the schema pages.

Custom View update — request body — body custom views item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the configuration for updating a Custom View by its ID, including the fields to update. Additional keys: not allowed
access_type	string	Optional	Represents the access type for the Custom View. Possible values: **shared** - The view is shared with selected users, roles, groups, or territories. **public** - The view is accessible to all users in the organization. **only_to_me** - The view is private and accessible only to the creator. One of: shared, public, only_to_me
category	string	Optional	Represents the category for the Custom View. Possible values: **public_views** - Views accessible to all users in the organization. **other_users_views** - Views created by other users in the organization. **shared_with_me** - Views shared with the current user. **created_by_me** - Views created by the current user. One of: public_views, other_users_views, shared_with_me, created_by_me
criteria	Model	Optional	Expand Custom Views — request body — body custom views item criteria
cross_filters	Model	Optional	Expand Custom Views — request body — body custom views item cross filters
favorite	null or integer	Optional	Represents the favorite order for the Custom View. A null value indicates the view is not marked as a favorite. Format: int32
fields	Model	Optional	Expand Custom Views — request body — body custom views item fields
locked	boolean	Optional	Indicates whether the Custom View is locked. Possible values: **true** - The view is locked. **false** - The view is not locked.
name	string	Optional	Represents the name of the Custom View. Maximum length: 50
shared_to	Model	Optional	Expand Custom Views — request body — body custom views item shared to
sort_by	JSON	Optional	Represents the field used to sort the records in the Custom View.
sort_by (anyOf 1)	Model	Alternative	Expand Sort Order — request body — body custom views item sort by
sort_by (anyOf 2)	null	Alternative	No sort is applied
sort_order	JSON	Optional	Represents the sort order applied to the records in the Custom View.
sort_order (anyOf 1)	string	Alternative	Represents the sort order for the Custom View. Possible values: **asc** - Ascending order. **desc** - Descending order. One of: asc, desc
sort_order (anyOf 2)	null	Alternative	Represents no sort order applied to the Custom View.

Referenced models: Custom Views — request body — body custom views item criteria, Custom Views — request body — body custom views item cross filters, Custom Views — request body — body custom views item fields, Sort Order — request body — body custom views item sort by, Custom Views — request body — body custom views item shared to

Sort Order by ID — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the bulk update success response containing a list of updated Custom View items. Additional keys: not allowed
custom_views	array	Required within parent	Represents the list of Custom View update success items. Maximum items: 200
custom_views[]	Model	Each item	Expand Sort Order by ID — response body — custom views item

Referenced models: Sort Order by ID — response body — custom views item

Custom Views — request body — body custom views item criteria

Field	Type	Presence	Description and constraints
$	JSON	Root	Represents the filter criteria of the Custom View
$ (anyOf 1)	Model	Alternative	Expand Related Records — request body — query filters
$ (anyOf 2)	null	Alternative	No criteria applied - the custom view returns all records

Referenced models: Related Records — request body — query filters

Custom Views — request body — body custom views item cross filters

Field	Type	Presence	Description and constraints
$	JSON	Root	Represents the cross-filter criteria of the Custom View
$ (anyOf 1)	Model	Alternative	Expand Get records from a specified module — request body — query cross filters
$ (anyOf 2)	null	Alternative	No cross-filter criteria applied

Referenced models: Get records from a specified module — request body — query cross filters

Custom Views — request body — body custom views item fields

Field	Type	Presence	Description and constraints
$	array	Root	Represents the list of fields included in the Custom View, each with display and pin configuration details. Maximum items: 250
$[]	object	Each item	Represents a field included in the Custom View, with configuration details such as pin status, pin order, and display width. Additional keys: not allowed
$[]._pin	boolean	Optional	Indicates whether the field is pinned in the Custom View. Possible values: **true** - The field is pinned. **false** - The field is not pinned.
$[]._pin_order	integer	Optional	Represents the order of the pinned field within the Custom View. Format: int32
$[]._width	integer	Optional	Represents the display width of the field in pixels. Format: int32
$[].api_name	string or null	Optional	Represents the API name of the field included in the Custom View. Maximum length: 255
$[].id	string or null	Optional	Represents the unique ID of the field included in the Custom View. Format: int64 Maximum length: 25

Sort Order — request body — body custom views item sort by

Field	Type	Presence	Description and constraints
$	object	Root	Represents a reference to a field in the Custom View, identified by its API name and unique ID. Additional keys: not allowed
api_name	string or null	Optional	Represents the API name of the field. A null value indicates no field is selected. Maximum length: 255
id	string or null	Optional	Represents the unique ID of the field. A null value indicates no field is selected. Format: int64 Maximum length: 25

Custom Views — request body — body custom views item shared to

Field	Type	Presence	Description and constraints
$	array or null	Root	Represents the list of users, roles, groups, or territories the Custom View is shared with. Maximum items: 250
$[]	object	Each item	Shared To Object Additional keys: not allowed
$[].id	string	Required within parent	ID of the user/group Format: int64 Maximum length: 25
$[].name	string	Optional	Name of the user/group Maximum length: 255
$[].subordinates	boolean or null	Optional	Specify true if subordinates are included, false otherwise
$[].type	string	Required within parent	Represents the type of the shared-to entity. Possible values: **territories** - The view is shared with a territory. **roles** - The view is shared with a role. **groups** - The view is shared with a group. **users** - The view is shared with a specific user. One of: territories, roles, groups, users

Sort Order by ID — response body — custom views item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the successful update response for a Custom View operation, including the status, code, message, and updated view ID. Additional keys: not allowed
code	string	Required within parent	Represents the success code for the update operation. Possible values: **SUCCESS** - The Custom View update completed successfully. Known values: SUCCESS
details	object	Required within parent	Represents the additional details for the successful update operation. Additional keys: not allowed
details.id	string	Required within parent	Represents the unique ID of the updated Custom View. Format: int64 Maximum length: 25
message	string	Required within parent	Represents the success message for the update operation. Maximum length: 255
status	string	Required within parent	Represents the status of the update response. Possible values: **success** - The operation was successful. Known values: success

Related Records — request body — query filters

Field	Type	Presence	Description and constraints
$	JSON	Root	Represents the top-level filter criterion for data selection, supporting both simple field-based filters and complex grouped filters with logical operators.
$ (anyOf 1)	Model	Alternative	Expand Related Records — request body — query filters value
$ (anyOf 2)	Model	Alternative	Expand Related Records — request body — query / filters / group_operator: AND, OR, and, or

Referenced models: Related Records — request body — query / filters / group_operator: AND, OR, and, or, Related Records — request body — query filters value

Policy, approvals and errors

SDK function policy ID: zoho.updatecustomview. Catalog operation: updateCustomView. 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