Zoho: Delete Custom Views

← Custom views operations · Get started

Operation zoho.deletecustomview

Provider route: DELETE /crm/v8/settings/custom_views. 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"]["deleteCustomView"]>[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.deleteCustomView(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.delete_custom_view(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Required within parent	Additional keys: not allowed
query.ids	array	Required within parent	List of custom view IDs Maximum items: 100 Minimum items: 1 Unique items: true
query.ids[]	string	Each item	Custom view ID Format: int64
query.module	string	Required within parent	Maximum length: 25

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
$	JSON	Root
$ (anyOf 1)	object	Alternative	Represents the response schema for a successful Custom View deletion. Additional keys: not allowed
$ (anyOf 1).custom_views	array	Required within parent	Represents the list of Custom Views deleted successfully. Maximum items: 200
$ (anyOf 1).custom_views[]	Model	Each item	Expand Delete Custom Views — response body — custom views custom views item
$ (anyOf 2)	object	Alternative	Represents the multi-status response for the delete operation, containing a mix of success and failure items. Additional keys: not allowed
$ (anyOf 2).custom_views	array	Required within parent	Represents the list of Custom View deletion results, including both successful and failed items. Maximum items: 200 Minimum items: 2
$ (anyOf 2).custom_views[]	JSON	Each item	Represents a deletion result item, which can be either a success or a failure response.
$ (anyOf 2).custom_views[] (anyOf 1)	Model	Alternative	Expand Delete Custom Views — response body — custom views custom views item
$ (anyOf 2).custom_views[] (anyOf 2)	Model	Alternative	Expand Delete Custom Views — response body — custom views custom views item value
$ (anyOf 2).custom_views (allOf 1)	JSON	All variants apply	Represents a successful deletion item for a Custom View.
$ (anyOf 2).custom_views (allOf 2)	JSON	All variants apply	Represents a deletion failure item for a Custom View.

Referenced models: Delete Custom Views — response body — custom views custom views item value, Delete Custom Views — response body — custom views custom views item

Schemas

Delete Custom Views — response body — custom views custom views item value

Field	Type	Presence	Description and constraints
$	JSON	Root	Represents the deletion failure details for a Custom View, containing the error code, status, message, and additional context.
$ (anyOf 1)	Model	Alternative	Expand Delete Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error
$ (anyOf 2)	Model	Alternative	Expand Delete Custom Views — response body — custom_views / custom_views / item / value / code: NOT ALLOWED, status: error

Referenced models: Delete Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error, Delete Custom Views — response body — custom_views / custom_views / item / value / code: NOT ALLOWED, status: error

Delete Custom Views — response body — custom views custom views item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the successful deletion response for a Custom View, including the status, code, and confirmation message. Additional keys: not allowed
code	string	Required within parent	Represents the success code for the deletion operation. Possible values: **SUCCESS** - The Custom View deletion completed successfully. Known values: SUCCESS
details	Model	Required within parent	Expand Custom View creation — response body — custom views custom views item details
message	string	Required within parent	Represents the success message for the deletion operation. Maximum length: 255
status	string	Required within parent	Represents the status of the deletion response. Possible values: **success** - The operation was successful. Known values: success

Referenced models: Custom View creation — response body — custom views custom views item details

Delete Custom Views — response body — custom_views / custom_views / item / value / code: INVALID DATA, status: error

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error details returned when the Custom View ID provided for deletion is invalid or the view has already been deleted. Additional keys: not allowed
code	string	Required within parent	Represents the error code for the invalid data error. Possible values: **INVALID_DATA** - The Custom View ID in the request is invalid or already deleted. Known values: INVALID_DATA
details	object	Required within parent	Represents the additional details about the invalid Custom View ID. Additional keys: not allowed
details.id	string	Required within parent	Represents the ID of the invalid or already-deleted Custom View. Format: int64 Maximum length: 25
message	string	Required within parent	Represents the error message describing the invalid data issue. Maximum length: 255
status	string	Required within parent	Represents the status of the response. Possible values: **error** - The request encountered an error. Known values: error

Delete Custom Views — response body — custom_views / custom_views / item / value / code: NOT ALLOWED, status: error

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error details returned when a Custom View cannot be deleted due to active associations. Additional keys: not allowed
code	string	Required within parent	Represents the error code for the not allowed deletion. Possible values: **NOT_ALLOWED** - The Custom View cannot be deleted because it has active associations. Known values: NOT_ALLOWED
details	Model	Required within parent	Expand Custom Views — response body — custom_views / custom_views / item / value / code: NOT ALLOWED, status: error details
message	string	Required within parent	Represents the error message describing why the deletion is not allowed. Maximum length: 255
status	string	Required within parent	Represents the status of the response. Possible values: **error** - The request encountered an error. Known values: error

Referenced models: Custom Views — response body — custom_views / custom_views / item / value / code: NOT ALLOWED, status: error details

Custom View creation — response body — custom views custom views item details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the ID details for a created or affected resource. Additional keys: not allowed
id	string	Required within parent	Represents the unique ID of the created or affected resource. Format: int64 Maximum length: 25

Custom Views — response body — custom_views / custom_views / item / value / code: NOT ALLOWED, status: error details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the details of associations that prevent the deletion of a Custom View, including the association type and the list of associated resources. Additional keys: not allowed
associations	array	Required within parent	Represents the list of associations that prevent the deletion of the Custom View. Maximum items: 50
associations[]	object	Each item	Represents an association entry containing the association type and the list of associated resources. Additional keys: not allowed
associations[].resources	array	Required within parent	Represents the list of resources associated with this association type. Maximum items: 100
associations[].resources[]	object	Each item	Represents a resource that prevents deletion when associated with the Custom View. Additional keys: not allowed
associations[].resources[].id	string	Required within parent	Represents the unique identifier of the associated resource. Format: int64 Maximum length: 25
associations[].resources[].name	string	Required within parent	Represents the display name of the associated resource. Maximum length: 255
associations[].type	string	Required within parent	Represents the association type, indicating the feature or module the resource belongs to. Maximum length: 50
id	string	Required within parent	Represents the unique ID of the Custom View that cannot be deleted. Format: int64 Maximum length: 25

Policy, approvals and errors

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