Zoho Recruit
metadata.modules.create
Creates a single custom module in Recruit. Requires the Recruit_Implied_Customize_Zoho_Recruit permission. This operation is not idempotent; submitting the same api_name multiple times will result in validation errors. Only one module can be created per request; batch creation is not supported.
Remote zoho/recruit
Remote (network-hosted)
Other tools also called metadata.modules.create?
See providers with this name
Input Schema
{
"type": "object",
"properties": {
"modules": {
"type": "array",
"items": {
"type": "object",
"required": [
"singular_label",
"plural_label",
"api_name",
"profiles"
],
"properties": {
"api_name": {
"type": "string",
"pattern": "^[a-zA-Z0-9]+$",
"maxLength": 50,
"minLength": 1,
"description": "Unique API identifier for the module. Alphanumeric only, no special characters allowed. Must be unique across all modules."
},
"profiles": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"format": "int64",
"description": "Numeric string identifier of the user profile. Determines module accessibility for users with this profile."
}
},
"description": "Profile access definition",
"additionalProperties": false
},
"maxItems": 203,
"minItems": 1,
"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.",
"uniqueItems": true
},
"plural_label": {
"type": "string",
"pattern": "^[a-zA-Z0-9]+$",
"maxLength": 25,
"minLength": 1,
"description": "Plural form of the module name. Alphanumeric only, no special characters allowed."
},
"display_field": {
"type": "object",
"properties": {
"data_type": {
"enum": [
"autonumber",
"text"
],
"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."
},
"auto_number": {
"type": "object",
"required": [
"start_number"
],
"properties": {
"prefix": {
"type": "string",
"maxLength": 50,
"description": "Optional prefix to prepend to the auto-generated number."
},
"suffix": {
"type": "string",
"maxLength": 50,
"description": "Optional suffix to append to the auto-generated number."
},
"start_number": {
"type": "string",
"pattern": "^[0-9]+$",
"maxLength": 16,
"description": "Starting number for the auto-number sequence. Must be a numeric string (e.g., '1', '100')."
}
},
"description": "Configuration for auto-number generation. Mandatory when data_type is 'autonumber'.",
"additionalProperties": false
},
"field_label": {
"type": "string",
"maxLength": 50,
"minLength": 1,
"description": "Label for the name field. Mandatory if display_field is provided and data_type is not specified."
}
},
"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.",
"additionalProperties": false
},
"singular_label": {
"type": "string",
"pattern": "^[a-zA-Z0-9]+$",
"maxLength": 25,
"minLength": 1,
"description": "Singular form of the module name. Alphanumeric only, no special characters allowed."
}
},
"description": "Module definition object containing module metadata, profiles, and optional display field configuration.",
"additionalProperties": false
},
"maxItems": 1,
"minItems": 1,
"description": "Array containing a single module definition to create. Only one module can be created per request."
}
}
}