CreateCustomModule
Create a new custom module in Zoho CRM.
Stored Procedure-Specific Information
Create custom modules within Zoho CRM. Creating a single module consumes 500 API credits.
To create a custom module, the PluralLabel, SingularLabel, and ProfileIds parameters are required. At least one Profile Id must be included in the ProfileIds parameter.
The value for the DisplayFieldDataType parameter can be 'text' or 'autonumber'.
When the value for DisplayFieldDataType parameter is 'text', the 'DisplayFieldLabel' parameter is required.
EXEC CreateCustomModule PluralLabel = 'Test', SingularLabel = 'Test', ProfileIds = '1000000000000000001,1000000000000000002', APIName = 'Test', DisplayFieldDataType = 'text', DisplayFieldLabel = 'Test';
When the value for DisplayFieldDataType parameter is 'autonumber', the 'AutoNumberStartNumber' parameter is required.
EXEC CreateCustomModule PluralLabel = 'Test', SingularLabel = 'Test', ProfileIds = '1000000000000000001,1000000000000000002', APIName = 'Test', DisplayFieldDataType = 'autonumber', AutoNumberStartNumber = '12';
EXEC CreateCustomModule PluralLabel = 'Test', SingularLabel = 'Test', ProfileIds = '1000000000000000001,1000000000000000002', APIName = 'Test', DisplayFieldDataType = 'autonumber', AutoNumberStartNumber = '12', AutoNumberPrefix = 'Test', AutoNumberSuffix = 'Test';
When the DisplayFieldDataType parameter is not provided with a value, the new module has a required field named '[ModuleName] Name'.
EXEC CreateCustomModule PluralLabel = 'Test', SingularLabel = 'Test', ProfileIds = '1000000000000000001,1000000000000000002', APIName = 'Test';
This name can be changed by providing the desired name in the DisplayFieldLabel parameter.
EXEC CreateCustomModule PluralLabel = 'Test', SingularLabel = 'Test', ProfileIds = '1000000000000000001,1000000000000000002', APIName = 'Test', DisplayFieldLabel = 'Test';
Input
| Name | Type | Description |
| PluralLabel | String | Represents the unique plural name of the module. A maximum of 25 characters, including spaces, is allowed. Note that the value of this field should not be empty, and only letters, numbers, and spaces are supported. |
| SingularLabel | String | Represents the unique singular name of the module. A maximum of 25 characters, including spaces, is allowed. Note that the value of this field should not be empty, and only letters, numbers, and spaces are supported. |
| ProfileIds | String | Comma-separated Ids of the profiles that should have access to the module. You must specify at least one profile Id. These can be obtained by querying the Profiles view. |
| APIName | String | Represents the unique API name of the module. A maximum of 50 characters are allowed which can include alphabets, numbers, spaces, and underscore. The API name should start with an English alphabet character. The API name should not end with an underscore (_) and should not contain two consecutive underscores (__). Note that if you skip this key, ZohoCRM generates the API name based on the value given in the PluralLabel parameter. |
| DisplayFieldDataType | String | Represents the data type of the display field of the module.
The allowed values are text, autonumber. |
| DisplayFieldLabel | String | Represents the unique label of the display field. This field is required when inserting a record in the new module when its type is 'text'. When type is 'autonumber', its value is auto-generated for every record. |
| AutoNumberStartNumber | Long | To be used when 'DisplayFieldDataType' is set to 'autonumber'. It specifies the starting number for the autonumber sequence. A maximum of 16 digits are allowed, and only numeric characters are allowed. Ensure there are no spaces in the key. |
| AutoNumberPrefix | String | To be used when 'DisplayFieldDataType' is set to 'autonumber'. It represents the prefix value to be added to the autonumber field value. A maximum of 50 characters are allowed, and only alphanumeric characters are allowed. |
| AutoNumberSuffix | String | To be used when 'DisplayFieldDataType' is set to 'autonumber'. It represents the suffix value to be added to the autonumber field value. A maximum of 50 characters are allowed, and only alphanumeric characters are allowed. |
Result Set Columns
| Name | Type | Description |
| Status | String | Indicates the status of the stored procedure execution. |
| Code | String | The code returned by ZohoCRM. |
| ModuleId | String | The Id of the newly created module. |
| Message | String | The message returned by the server. |