> ## 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: README

> Create a custom CRM module. Includes SDK V2 and CLI requests, input constraints, response fields, and Deepline credit cost.

Create a custom CRM module.

<Info>
  Tool ID: `zoho_crm_modules_create_modules`
</Info>

## Run this action

Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.

```ts theme={null}
import { Deepline } from 'deepline';

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

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={null}
deepline tools execute zoho_crm_modules_create_modules --input '{
  "modules": [
    {
      "singular_label": "example",
      "plural_label": "example",
      "api_name": "Example",
      "profiles": [
        {
          "id": "id_123"
        }
      ]
    }
  ]
}' --json
```

## Example response

The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.

```json theme={null}
{
  "data": {
    "modules": [
      {
        "code": "SUCCESS",
        "details": {
          "id": "id_123"
        },
        "message": "module created successfully",
        "status": "success"
      }
    ]
  }
}
```

Use `deepline tools get zoho_crm_modules_create_modules --json` for the latest machine-readable contract.

## Input reference

Request body for creating a new custom module in Zoho CRM

| Name              | Type    | Required | Default | Details                                                                                                                                |
| ----------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| `payload.modules` | `array` | No       | —       | Array containing a single module definition to create. Only one module can be created per request. Minimum items: 1. Maximum items: 1. |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Request body for creating a new custom module in Zoho CRM",
    "properties": {
      "modules": {
        "type": "array",
        "description": "Array containing a single module definition to create. Only one module can be created per request.",
        "minItems": 1,
        "maxItems": 1,
        "items": {
          "type": "object",
          "description": "Module definition object containing module metadata, profiles, and optional display field configuration.",
          "properties": {
            "singular_label": {
              "type": "string",
              "description": "Singular form of the module name. Alphanumeric only, no special characters allowed.",
              "minLength": 1,
              "maxLength": 25,
              "pattern": "^[a-zA-Z0-9]+$"
            },
            "plural_label": {
              "type": "string",
              "description": "Plural form of the module name. Alphanumeric only, no special characters allowed.",
              "minLength": 1,
              "maxLength": 25,
              "pattern": "^[a-zA-Z0-9]+$"
            },
            "api_name": {
              "type": "string",
              "description": "Unique API identifier for the module. Alphanumeric only, no special characters allowed. Must be unique across all modules.",
              "minLength": 1,
              "maxLength": 50,
              "pattern": "^[a-zA-Z0-9]+$"
            },
            "profiles": {
              "type": "array",
              "description": "Array of profile IDs that determine which user profiles can access this module. Must contain at least one profile. Duplicate profile IDs are not allowed.",
              "minItems": 1,
              "maxItems": 203,
              "uniqueItems": true,
              "items": {
                "type": "object",
                "description": "Profile access definition",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "Numeric string identifier of the user profile. Determines module accessibility for users with this profile.",
                    "format": "int64"
                  }
                },
                "required": [
                  "id"
                ],
                "additionalProperties": false
              }
            },
            "display_field": {
              "type": "object",
              "description": "Defines the primary name field for the module. Optional, but if provided, either field_label or data_type is mandatory. If data_type is 'autonumber', then auto_number configuration with start_number is mandatory.",
              "properties": {
                "field_label": {
                  "type": "string",
                  "description": "Label for the name field. Mandatory if display_field is provided and data_type is not specified.",
                  "minLength": 1,
                  "maxLength": 50
                },
                "data_type": {
                  "type": "string",
                  "description": "Type of the name field. 'autonumber' for auto-generated sequential IDs (requires auto_number configuration), 'text' for user-entered text. Mandatory if display_field is provided and field_label is not specified.",
                  "enum": [
                    "autonumber",
                    "text"
                  ]
                },
                "auto_number": {
                  "type": "object",
                  "description": "Configuration for auto-number generation. Mandatory when data_type is 'autonumber'.",
                  "properties": {
                    "prefix": {
                      "type": "string",
                      "description": "Optional prefix to prepend to the auto-generated number.",
                      "maxLength": 50
                    },
                    "start_number": {
                      "type": "string",
                      "description": "Starting number for the auto-number sequence. Must be a numeric string (e.g., '1', '100').",
                      "maxLength": 16,
                      "pattern": "^[0-9]+$"
                    },
                    "suffix": {
                      "type": "string",
                      "description": "Optional suffix to append to the auto-generated number.",
                      "maxLength": 50
                    }
                  },
                  "required": [
                    "start_number"
                  ],
                  "additionalProperties": false
                }
              },
              "additionalProperties": false
            }
          },
          "required": [
            "singular_label",
            "plural_label",
            "api_name",
            "profiles"
          ],
          "additionalProperties": false
        }
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name                               | Type                            | Required | Default | Details                                                                                                                                  |
| ---------------------------------- | ------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `result.data`                      | `object`                        | Yes      | —       | Success response containing the created module details                                                                                   |
| `result.data.modules`              | `array`                         | Yes      | —       | Array containing the result of the single module creation request. Always contains exactly one item. Minimum items: 1. Maximum items: 1. |
| `result.data.modules[].code`       | `"SUCCESS"`                     | Yes      | —       | Operation status code indicating successful creation Allowed: `SUCCESS`.                                                                 |
| `result.data.modules[].details`    | `object`                        | Yes      | —       | Contains the unique identifier of the newly created module                                                                               |
| `result.data.modules[].details.id` | `string`                        | Yes      | —       | Unique numeric identifier for the created module Format: `int64`.                                                                        |
| `result.data.modules[].message`    | `"module created successfully"` | Yes      | —       | Human-readable success message confirming module creation Allowed: `module created successfully`.                                        |
| `result.data.modules[].status`     | `"success"`                     | Yes      | —       | Overall operation status Allowed: `success`.                                                                                             |
| `result.meta`                      | `object`                        | No       | —       | Additional response metadata (status, paging).                                                                                           |

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

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Success response containing the created module details",
        "properties": {
          "modules": {
            "type": "array",
            "description": "Array containing the result of the single module creation request. Always contains exactly one item.",
            "minItems": 1,
            "maxItems": 1,
            "items": {
              "type": "object",
              "description": "Module creation result",
              "properties": {
                "code": {
                  "type": "string",
                  "description": "Operation status code indicating successful creation",
                  "enum": [
                    "SUCCESS"
                  ]
                },
                "details": {
                  "type": "object",
                  "description": "Contains the unique identifier of the newly created module",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Unique numeric identifier for the created module",
                      "format": "int64"
                    }
                  },
                  "required": [
                    "id"
                  ],
                  "additionalProperties": false
                },
                "message": {
                  "type": "string",
                  "description": "Human-readable success message confirming module creation",
                  "enum": [
                    "module created successfully"
                  ]
                },
                "status": {
                  "type": "string",
                  "description": "Overall operation status",
                  "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](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)