Zoho CRM: Modules Update Module By API Name

Change one Zoho CRM module’s labels or the profiles that can access it.

Tool ID: zoho_crm_modules_update_module_by_api_name

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'zoho_crm_modules_update_module_by_api_name',
  {
    "moduleIdentifier": {},
    "modules": [
      {
        "singular_label": "example",
        "plural_label": "example",
        "id": "id_123",
        "profiles": [
          {
            "id": "id_123"
          }
        ]
      }
    ]
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute zoho_crm_modules_update_module_by_api_name --input '{
  "moduleIdentifier": {},
  "modules": [
    {
      "singular_label": "example",
      "plural_label": "example",
      "id": "id_123",
      "profiles": [
        {
          "id": "id_123"
        }
      ]
    }
  ]
}' --json

Example response

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

{
  "data": {
    "modules": [
      {
        "code": "SUCCESS",
        "details": {
          "id": "id_123"
        },
        "message": "module updated successfully",
        "status": "success"
      }
    ]
  }
}

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

Input reference

Request payload for updating module configuration including labels and profile associations.

Name	Type	Required	Default	Details
`payload.moduleIdentifier`	`object`	Yes	—	Identifier for the module to retrieve, either numeric ID or API name. Use numeric ID for precise identification or API name for human-readable reference. Case-sensitive when using API name.
`payload.modules`	`array`	Yes	—	Array containing a single module object to update. Minimum items: 1. Maximum items: 1.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Response wrapper containing the result of the module update operation.
`result.data.modules`	`array`	Yes	—	Array containing a single success response object for the updated module. Minimum items: 1. Maximum items: 1.
`result.data.modules[].code`	`"SUCCESS"`	Yes	—	Operation result code indicating successful update. Allowed: `SUCCESS`.
`result.data.modules[].details`	`object`	Yes	—	Details object containing the ID of the updated module.
`result.data.modules[].details.id`	`string`	Yes	—	Unique numeric identifier of the successfully updated module. Numeric string representation of a 64-bit positive integer (Java long/DB bigint). Format: `int64`.
`result.data.modules[].message`	`"module updated successfully"`	Yes	—	Human-readable success message confirming the module update. Allowed: `module updated successfully`.
`result.data.modules[].status`	`"success"`	Yes	—	Operation status indicator. 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

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation