Zoho: Deactivate Layout

← Layouts activate deactivate operations · Get started

Operation zoho.layoutdeactivate

Provider route: DELETE /crm/v8/settings/layouts/{id}/actions/activate. 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["layoutsActivateDeactivate"]["layoutDeactivate"]>[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.layoutsActivateDeactivate.layoutDeactivate(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_activate_deactivate.layout_deactivate(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	Layout identifier as a 64-bit integer Format: int64
query	object	Required within parent	Additional keys: not allowed
query.module	string	Required within parent	Module API name Maximum length: 100 Minimum length: 1 Pattern: ^[A-Z][A-Za-z0-9_]*$
query.transfer_to	string	Required within parent	Target layout ID for configuration transfer Format: int64

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	Represents the success response returned when a layout is successfully deactivated. Additional keys: not allowed
layouts	array	Required within parent	Array containing the result of the layout deactivation operation. Always returned in the response. Maximum items: 1 Minimum items: 1
layouts[]	object	Each item	Represents the result details for the deactivated layout. Additional keys: not allowed
layouts[].code	string	Required within parent	Represents the operation result code. Possible values: SUCCESS - Indicates the layout was deactivated successfully. Always returned in the response. Known values: SUCCESS
layouts[].details	object	Required within parent	Contains the details of the deactivated layout. Always returned in the response. Additional keys: not allowed
layouts[].details.id	string	Required within parent	Represents the unique identifier of the deactivated layout. Always returned in the response. Format: int64
layouts[].message	string	Required within parent	Represents the confirmation message for the deactivation operation. Always returned in the response. Maximum length: 200
layouts[].status	string	Required within parent	Represents the overall operation status. Possible values: success - Indicates the deactivation completed without errors. Always returned in the response. Known values: success

Policy, approvals and errors

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