Create custom fields in a module

POST/settings/fields

Use it in a workflow

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

Request

Query parameters

modulestringrequired

Specify the API name of the module for which you want to retrieve field data. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for valid values.

Request body

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

fieldsarray<object>

Specify the list of fields to create.

field_labelstringrequired

Specify the unique display label of the field.

data_typestringrequired

Specify the data type of the field.

One oftexttextareaemailphonepicklistmultiselectpicklistdatedatetimeintegerautonumbercurrencypercentbigintdoublewebsitebooleanfileuploadimageuploadlookupuserlookupmultiselectlookupmultiuserlookupformularollup_summaryaddress

lengthinteger (int32)

Specify the maximum number of characters allowed. Varies by data type.

filterableboolean

Specify whether the field can be used in filters.

tooltipobject2 fields

Represents the tooltip content for the field. **Possible names**: **static_text** : Specifies that the field should have a static text tooltip. The tooltip content will be displayed in the field when the user clicks on the field box. **info_icon** : Specifies that the field should have an info icon tooltip. Clicking on the "info icon" will display the tooltip contents. Note that it is mandatory to specify both the name and value when you specify tooltip key.

profilesarray<object>2 fields

Each object in the array represents the name and ID of the profile that has access to the field. By default, all organization users will have access to the field. **Possible permission types:** read_write, read_only, and hidden. **read_write:** The user has read and write permissions for the field. **read_only:** The user has only read permission for the field. **hidden:** The field is not visible to the user. Note that it is mandatory to specify a permission type to the profiles in order to access the field.

externalobject2 fields

Specify the external field configuration for third-party app integration.

cryptoneOf

encrypt_casestring

Specify the permission case for encrypted field.

One ofuppercaselowercase

textareaobject1 fields

Specify the text area field configuration.

uniqueoneOf

hipaa_compliance_enabledboolean

Specify the enable HIPAA compliance for this field.

privateobject1 fields

Specify the gDPR compliance configuration.

pick_list_valuesarray<object>4 fields

Specify the picklist configuration.

enable_record_stateboolean

Specify whether record state is enabled for the picklist field.

default_valuestring

Specify the default value for the picklist field.

pick_list_values_sorted_lexicallyboolean

Specify whether picklist values are sorted lexically.

enable_colour_codeboolean

Specify whether colour coding is enabled for the picklist field.

global_picklistobject2 fields

Specify the global picklist configuration.

history_tracking_enabledboolean

Specify whether history tracking is enabled for the field.

history_trackingobject3 fields

Specify the history tracking configuration.

separatorboolean

Specify whether to use a thousands separator for number fields.

auto_numberobject3 fields

Specify the configuration for auto number fields.

_update_existing_recordsboolean

Specify whether to update existing auto-number records with the new format.

formulaobject6 fields

Specify the details of the formula field, including the return type and the expression.

decimal_placenumber (int32)

Specify the number of decimal places for the formula field. This is valid for double and currency return types. Possible values are from 0 to 9, both inclusive.

number_separatorboolean

Specify whether to display the field value in formatted view. The default value is true.

reference_idstring

Represents the temporary identifier used to reference a screen within the same wizard request payload.

currencyobject2 fields

Specify the currency field configuration.

rollup_summaryobject4 fields

Specify the rollup summary field configuration.

lookupobject5 fields

Specify the lookup field configuration.

multiselectlookupobject2 fields

Specify the multi-select lookup field configuration.

association_detailsobject2 fields

Specify the association details configuration.

json

{
  "fields": [
    {
      "field_label": "Your Name",
      "data_type": "text",
      "length": 150,
      "filterable": true,
      "tooltip": {
        "name": "static_text",
        "value": "string"
      },
      "profiles": [
        {
          "id": "1385208000000973001",
          "permission_type": "read_write"
        }
      ],
      "external": {
        "type": "user",
        "show": true
      },
      "crypt": null,
      "encrypt_case": "lowercase",
      "textarea": {
        "type": "small"
      },
      "unique": null,
      "hipaa_compliance_enabled": false
    }
  ]
}

Response

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

fieldsarray<object>

Represents the list of creation results, one per field submitted in the request.

codestringrequired

Represents the result code.

One ofSUCCESS

detailsobjectrequired1 fields

Represents the details of the created field.

messagestringrequired

Represents the result message.

statusstringrequired

Represents the status of the operation.

One ofsuccess

json

{
  "fields": [
    {
      "code": "SUCCESS",
      "details": {
        "id": "111112000000067259"
      },
      "message": "field created",
      "status": "success"
    }
  ]
}

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

Was this page helpful?