Zoho: Delete a custom layout

← Layouts operations · Get started

Operation zoho.deletelayout

Provider route: DELETE /crm/v8/settings/layouts/{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["layouts"]["deleteLayout"]>[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.layouts.deleteLayout(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.layouts.delete_layout(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	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
query	object	Required within parent	Additional keys: not allowed
query.module	string	Required within parent	Unique API identifier for the module used in third-party integrations; starts with a letter, contains only alphanumeric characters and underscores, and has no consecutive or trailing underscores. Maximum length: 50
query.transfer_to	string	Optional	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
query.pipeline	string	Optional	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
query.stage	string	Optional	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$

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 Delete a custom layout — response body

Referenced models: Delete a custom layout — response body

Schemas

Delete a custom layout — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response body returned when one or more layouts are successfully deleted, containing per-layout deletion results. Additional keys: not allowed
layouts	array	Required within parent	Contains one entry per layout included in the deletion request, each reporting the individual outcome — such as success or failure — for that specific layout. Maximum items: 1 Minimum items: 1
layouts[]	Model	Each item	Expand Delete a custom layout — response body — layouts item

Referenced models: Delete a custom layout — response body — layouts item

Delete a custom layout — response body — layouts item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the outcome of a single layout deletion attempt within a batch operation, including a status code and descriptive message for that layout. Additional keys: not allowed
code	string	Required within parent	Indicates the outcome code returned for the layout deletion attempt. Possible values: `SUCCESS` — the layout deletion completes successfully. Known values: SUCCESS
details	Model	Required within parent	Expand Delete a custom layout — response body — layouts item details
message	string	Required within parent	Contains a descriptive message summarising the outcome of the layout deletion operation, providing context for both successful completions and failure conditions. Maximum length: 500
status	string	Required within parent	Represents the overall processing state of the layout deletion request. Possible values: `success` — the layout was removed as requested. Known values: success

Referenced models: Delete a custom layout — response body — layouts item details

Delete a custom layout — response body — layouts item details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the identifying details of a layout that has been successfully deleted, returned in the deletion response to confirm which layout was removed. Additional keys: not allowed
id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the deleted layout. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$

Policy, approvals and errors

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