Create a custom module

POST/settings/modules

Use it in a workflow

Add a step and choose the Zoho CRM connector.
Pick the Create a custom module action (under Metadata).
Fill in the fields below, then reference the result from later steps as {{createACustomModule.response.data}}.

Request

Request body

Enter the body as JSON in the step's Body field.

modulesarray<object>required

Specify the module definitions to create. Only one module definition object can be included per request.

singular_labelstringrequired

Specify the unique singular name of the module. Only letters, numbers, and spaces are supported.

plural_labelstringrequired

Specify the unique plural name of the module. Only letters, numbers, and spaces are supported.

api_namestring

Specify the unique API name for the module. The name must begin with an English alphabet character, must not end with an underscore, and must not contain two consecutive underscores. If omitted, the system generates the API name from the **plural_label** value.

access_typestring

Specify the access type for the module.Defaults to org_based when omitted. Use team_based to create a team module. Possible values: **org_based** - The module is accessible based on organizational profile settings. **team_based** - The module is restricted to team-based access.

One oforg_basedteam_basedDefault "org_based"

profilesarray<object>1 fields

Specify the array of profile IDs that determine which user profiles can access this module. Required for org_based modules. Do not pass this key for team_based modules. Duplicate profile IDs are not allowed.

display_fieldobject3 fields

Specify the details of the display field for the module. This is optional, but if provided, either field_label or data_type is mandatory. Supported data types are **autonumber** and **text**. If this is not specified, the system generates a text display field. If data_type is 'autonumber', then auto_number configuration with start_number is mandatory.

json

{
  "modules": [
    {
      "singular_label": "string",
      "plural_label": "string",
      "api_name": "string",
      "access_type": "org_based",
      "profiles": [
        {
          "id": "4832675000000850800"
        }
      ],
      "display_field": {
        "field_label": "string",
        "data_type": "autonumber",
        "auto_number": {
          "start_number": "string",
          "prefix": "string",
          "suffix": "string"
        }
      }
    }
  ]
}

Response

Returns 201 with an object. Read it in later steps with {{createACustomModule.response.data.<field>}}.

modulesarray<object>

Represents the array containing the result of the single module creation request. Contains exactly one item for each module creation request.

codestringrequired

Represents the status code of the module creation operation. Possible values: **SUCCESS** - The module creation completed successfully.

One ofSUCCESS

detailsobjectrequired1 fields

Represents the details of the created module, including its unique identifier.

messagestringrequired

Represents the confirmation message for the module creation operation. Possible values: **module created successfully** - The module creation completed without errors.

One ofmodule created successfully

statusstringrequired

Represents the overall status of the module creation operation. Possible values: **success** - The module creation completed successfully.

One ofsuccess

json

{
  "modules": [
    {
      "code": "SUCCESS",
      "details": {
        "id": "string"
      },
      "message": "module created successfully",
      "status": "success"
    }
  ]
}

Need more? See the Zoho CRM guide for connection setup and behaviour shared by every action.

Was this page helpful?