> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Zoho CRM: Modules Update Module By API Name

> Change one Zoho CRM module's labels or the profiles that can access it. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

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

> [!NOTE]
>
> 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.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
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

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
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.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "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. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Request payload for updating module configuration including labels and profile associations.",
    "properties": {
      "moduleIdentifier": {
        "type": "object",
        "description": "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.",
        "additionalProperties": true
      },
      "modules": {
        "type": "array",
        "description": "Array containing a single module object to update.",
        "minItems": 1,
        "maxItems": 1,
        "items": {
          "type": "object",
          "description": "Module configuration object containing labels and profile assignments to update.",
          "properties": {
            "singular_label": {
              "type": "string",
              "description": "Singular display label for the module. Maximum 25 characters, alphanumeric and spaces only, no special characters allowed.",
              "minLength": 1,
              "maxLength": 25,
              "pattern": "^[A-Za-z0-9 ]+$"
            },
            "plural_label": {
              "type": "string",
              "description": "Plural display label for the module. Maximum 25 characters, alphanumeric and spaces only, no special characters allowed.",
              "minLength": 1,
              "maxLength": 25,
              "pattern": "^[A-Za-z0-9 ]+$"
            },
            "id": {
              "type": "string",
              "description": "Unique numeric identifier of the module to update. Must match an existing module. Numeric string representation of a 64-bit positive integer (Java long/DB bigint).",
              "format": "int64"
            },
            "profiles": {
              "type": "array",
              "description": "List of unique profile IDs that should have access to this module. Cannot be empty. Order not significant. Maximum 203 profiles allowed.",
              "minItems": 1,
              "maxItems": 203,
              "uniqueItems": true,
              "items": {
                "type": "object",
                "description": "Profile assignment specifying which profile should have access to this module.",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "Numeric identifier of the profile. Numeric string representation of a 64-bit positive integer (Java long/DB bigint).",
                    "format": "int64"
                  }
                },
                "required": [
                  "id"
                ],
                "additionalProperties": false
              }
            }
          },
          "required": [
            "singular_label",
            "plural_label",
            "id",
            "profiles"
          ],
          "additionalProperties": false
        }
      }
    },
    "required": [
      "moduleIdentifier",
      "modules"
    ],
    "additionalProperties": false
  }
  ```
</details>

## 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). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Response wrapper containing the result of the module update operation.",
        "properties": {
          "modules": {
            "type": "array",
            "description": "Array containing a single success response object for the updated module.",
            "minItems": 1,
            "maxItems": 1,
            "items": {
              "type": "object",
              "description": "Success response object containing operation result, module ID, and status.",
              "properties": {
                "code": {
                  "type": "string",
                  "description": "Operation result code indicating successful update.",
                  "enum": [
                    "SUCCESS"
                  ]
                },
                "details": {
                  "type": "object",
                  "description": "Details object containing the ID of the updated module.",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Unique numeric identifier of the successfully updated module. Numeric string representation of a 64-bit positive integer (Java long/DB bigint).",
                      "format": "int64"
                    }
                  },
                  "required": [
                    "id"
                  ],
                  "additionalProperties": false
                },
                "message": {
                  "type": "string",
                  "description": "Human-readable success message confirming the module update.",
                  "enum": [
                    "module updated successfully"
                  ]
                },
                "status": {
                  "type": "string",
                  "description": "Operation status indicator.",
                  "enum": [
                    "success"
                  ]
                }
              },
              "required": [
                "code",
                "details",
                "message",
                "status"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "modules"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

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

## Related documentation

* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.