Zoho CRM: Layouts Activate Deactivate Layout Deactivate

Deactivate a Zoho CRM layout and move its profiles and settings to another layout.

Tool ID: zoho_crm_layouts_activate_deactivate_layout_deactivate

Run this action

This action has conditional or dynamic inputs. A static example cannot describe these inputs reliably. Read the live contract before you execute this action:

deepline describe zoho_crm_layouts_activate_deactivate_layout_deactivate --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "layouts": [
      {
        "code": "SUCCESS",
        "details": {
          "id": "id_123"
        },
        "message": "Example message",
        "status": "success"
      }
    ]
  }
}

Use deepline describe zoho_crm_layouts_activate_deactivate_layout_deactivate --json for the latest machine-readable contract.

Input reference

Deactivates an active layout and transfers its configuration (profile associations, permissions, field mappings) to another active layout within the same module. At least one active layout must remain in the module. This operation is idempotent - attempting to deactivate an already deactivated layout returns an error (ALREADY_DEACTIVATED).

Name	Type	Required	Default	Details
`payload.id`	`string`	Yes	—	The unique identifier of the layout to activate or deactivate. Must be a valid layout ID that exists within the specified module. Layout ID values are data center-specific. Format: `int64`.
`payload.module`	`string`	Yes	—	The CRM module API name that contains the layout. Supports both standard Zoho CRM modules (e.g., Leads, Contacts, Deals) and custom modules created in the organization. Module names follow PascalCase convention and may contain underscores for custom modules. Minimum length: 1. Maximum length: 100. Pattern: `^[A-Z][A-Za-z0-9_]*$`.
`payload.transfer_to`	`string`	Yes	—	The ID of an active layout within the same module to transfer the configuration to. Must be different from the layout being deactivated. The target layout must not have any conflicting configurations. Format: `int64`.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Success response for layout deactivation operation
`result.data.layouts`	`array`	Yes	—	Array containing the deactivation result Minimum items: 1. Maximum items: 1.
`result.data.layouts[].code`	`"SUCCESS"`	Yes	—	Operation result code indicating successful deactivation Allowed: `SUCCESS`.
`result.data.layouts[].details`	`object`	Yes	—	Additional details about the deactivated layout
`result.data.layouts[].details.id`	`string`	Yes	—	The unique identifier of the deactivated layout Format: `int64`.
`result.data.layouts[].message`	`string`	Yes	—	Human-readable confirmation message Maximum length: 200.
`result.data.layouts[].status`	`"success"`	Yes	—	Overall operation status Allowed: `success`.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

Example response

Input reference

Output reference

Deepline cost

Related documentation