Create Custom Fields

Parameter

• modulestring, mandatory

  Specify the module in which you want to create custom fields, such as Leads, Contacts, etc. Use the GET - Modules API to retrieve modules API names and IDs. 

Input JSON Keys

• field_labelstring, mandatory

  It represents the unique display label of the field.

• data_typestring, mandatory

  It represents the data type of the field. See Field Types: Data Types and Length Limits for more information on the available data types.

• lengthinteger, optional

  It represents the maximum number of characters allowed for a field. Certain fields have specific character limits. See Field Types: Data Types and Length Limits for more information.

• tooltipJSON object, optional

  Represents the tooltip content for the field.
  Possible names:
  static_text : Specifies that the field should have a static text tootltip. 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 tootltip key.

• profilesJSON array, optional

  Each object in the array represents the name and ID of the profile that has access to the field. By default, all org 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.

• uniqueJSON object, optional

  It specifies whether to mark the field as a unique field or not. The accepted value for case_sensitive is false.

• cryptJSON object, optional

  Represents whether to store the field's value in encrypted form or not.

  The possible values are: 

  encryption - The field's value will be stored in encrypted form. This is supported for the following datatypes : text, textarea, email, phone, date, datetime, integer, currency, bigint, double, and website. 
  decryption - The field's value will not be stored in encrypted form. The default value is decryption.

• externalJSON object, optional

  Represents whether to mark the field as an external field, where information about the record from a third-party application can be stored. The possible value for the type are: user - A different external ID will be generated for each user, and org - All the users in the org will have a common external ID. Refer here for more information. Supported field data type is text.

Field Types: Data Types and Length Limits

The table below presents a list of field types, their corresponding data types, and the associated length limits:

Input JSON Keys for "Text Area" ("data_type": "textarea")

• textareaJSON object, mandatory

  It is a multi-line text area field that allows you to add additional information to the record. The following represents the possible values of type key, along with its allowed characters.

  • small - It is a text area type that allows upto 2000 characters.
  • large - It is a text area type that allows upto 32000 characters.
  • rich_text - It is a text area type that allows up to 50000 characters.

Input JSON Keys for "Email" ("data_type": "email")

• hipaa_compliance_enabledboolean, optional

  This key helps you decide how you want to manage and process health related data of your customers to comply with HIPAA. To use this key, please enable it through the UI. For that, Go to Setup > Security Control > Compliance Setting > HIPAA Compliance.

• privateJSON object, optional

  This key decide how you want to handle, manage, and process personal data of your customers to comply with GDPR for your organization. To use this key, please enable it through the UI. For that, Go to Setup > Security Control > Compliance Setting > GDPR Compliance. 

  Possible values for the type : Low and High.

Input JSON Keys for "Picklist Field" ("data_type": "picklist"), "Multi-select Picklist Field" ("data_type": "multiselectpicklist"), and "Global PickList Field" ("data_type": "picklist")

For picklist field, the value of data_type should be picklist. For multiselect picklist field, the value of data_type should be multiselectpicklist. Refer to the sample input for more details.

• pick_list_valuesJSON array, mandatory

  It represents the values or options of the picklist field. 

  • display_valuestring, mandatory

    The unique display value for the picklist, which will be displayed in the CRM UI. 

  • actual_valuestring, mandatory

    The unique reference value associated with the particular option.

• pick_list_values_sorted_lexicallyboolean, optional

  It represents the sort order preference for the global set values. 
  Possible values are : true - alphabetical order, false - given order. The default value is false.

• enable_colour_codeboolean, optional

  Specify whether to enable color for the picklist options. The default value is false.

• global_picklistJSON object, optional (mandatory while associate a global picklist)

  Use this key to associate a global picklist to a module.

  • idstring, mandatory

    Represents the unique ID of the global picklist. Get your Global Picklist IDs and other related details here.

Field Types: "Date" ("data_type": "date") and "DateTime" ("data_type": "datetime")

Input JSON Key for "Integer Field" ("data_type": "integer")

• separatorboolean, optional

  Represents whether to display the number in a formatted view for better readability, or not. The number format can be customized for each user in the Personal Settings. The default value is true.

Input JSON Keys for "Auto Number" ("data_type": "autonumber")

• auto_numberJSON object, mandatory

  Contains the details of the auto number field.

  • start_numberinteger, mandatory

    It specifies the starting number for the auto number sequence.

  • prefixstring, optional

    It represents the prefix value to be added to the autonumber field value. 

  • suffixstring, optional

    It represents the suffix value to be added to the autonumber field value. 

• _update_existing_recordsboolean, object

  Specify whether the existing auto-number records should be replaced with new auto-numbers of the specified format or not. Default value is false.

Input JSON Keys for "Formula" ("data_type": "formula")

• formulaJSON object, mandatory

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

  • return_typestring, mandatory

    Specify the return type for the formula field. Possible values are : double, currency, text, date, datetime, and boolean.

  • expressionstring, mandatory

    Specify the formula expression. Please refer here to learn more about formula expressions, and how to draft them.

• decimal_placeinteger, optional

  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, optional

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

Input JSON Keys for "Currency" ("data_type": "currency")

• currencyJSON object, mandatory

  The object containing the currency specific details for the field.

  • rounding_optionstring, mandatory

    Specify the rounding option for the currency field. 

    Possible rounding options: 

    • normal - No rounding operations involved.
    • round_off - Rounds the decimal part to the nearest whole number based on the specified precision. 
      For example, for a decimal_value of 3 and precision 2:
      1234.567 rounds down to 1234.57
      1234.123 rounds down to 1234.12
    • round_up - Rounds the decimal part up to the nearest whole number based on the specified precision. 
      For example, for a decimal_value of 2 and precision 2:
      1234.567 rounds down to 1234.57
      1234.123 rounds down to 1234.13
    • round_down - Rounds the decimal part down the nearest whole number based on the specified precision. 
      For example, for a decimal_value of 2 and precision 2:
      1234.567 rounds down to 1234.56
      1234.123 rounds down to 1234.12
  • precisioninteger, optional

    Represents the number of decimal places displayed for the currency value in the user interface. This value should be less than decimal_place 
    Example: Currency value: $123.466, the precision value is set to 2, the final currency value will be $123.47. (Note: "rounding_option" : "round_up").

• decimal_placeinteger, optional

  Defines the maximum numberof decimal places allowed for storing currency values in the field. This value cannot exceed 9. Values exceeding the set decimal_place will be truncated during storage.

Field Types: Percent, BigInt, Double, Website, and Boolean 

Field Types: "File Upload" ("data_type": "fileupload") and "Image Upload" ("data_type": "imageupload")

Input JSON Keys for "Lookup Field" ("data_type": "lookup")

• lookupJSON object, mandatory

  Lookup fields allows you to associate records from different modules with your current module. The lookup JSON object contains the details of the field being created.

  • modulestring, mandatory

    Specify the module API name of the module to be associated via the lookup field. Use the Modules API to get the module API names.

• display_labelstring, mandatory

  It represents the display label of the lookup field in the related list.  

• revalidate_filter_during_editboolean , optional

  Specify whether to revalidate the filters during edit. When the value is set to true, the pre-defined condition with the lookup filter will be checked during record creation and updation.

• query_detailsJSON object , optional

  Specify the criteria for filtering the records in the lookup field.

  • criteriaJSON object , mandatory when the query_details JSON object is specified

    It represents the criteria for filtering records.

  • group_operatorstring , optional (it is mandatory to specify when there are more than one condition) 

    Specifies the group operator used in the criteria (e.g., AND, OR).

  • groupJSON array

    It represents the group of criteria for filtering records.

    • fieldJSON object 

      It represents the API name of the field in the target module.

    • comparatorstring 

      It represents the comparison operator used in the criterion (e.g., contains and not_equal).

    • valuestring 

      It represents the value used in the criterion. Check the sample input section for reference.

Input JSON Keys for "User Lookup" ("data_type": "userlookup")

• sharing_propertiesJSON object, optional

  Specify if the user has access to the records that the field associates to.

  • share_preference_enabledboolean, mandatory (It is mandatory when the "sharing_properties" JSON object is specified)

    It represents whether share preferences are enabled (true), or disabled (false) for the field.

  • share_permissionboolean, mandatory (It is mandatory when the "sharing_properties" JSON object is specified)

    It represents the sharing permission for the field.
    Possible values: 

    • full-access
    • read-write
    • read-only

Possible Errors

• INVALID_DATAHTTP 400
  • Given data seems to be invalid
  • The given profile ID seems to be invalid

  Resoutions:

  • Specify a valid data in the input. Please refer above to the Input JSON Keys.
  • Specify a valid profile ID.
• DEPENDENT_MISMATCHHTTP 400
  • The given length value seems to be invalid.
  • The dependent fields seems to be invalid or missing

  Resolutions:

  • The value given in the length attribute is invalid, or the value is larger than the actual limit. Please refer to the Field Types: Data Types and Length Limits to know more about the limits.
  • Specify all required valid dependent fields along with their corresponding values.
• LIMIT_EXCEEDEDHTTP 400

  The field has reached its maximum creation limit
  Resolution:

  You have already created the maximum possible custom fields. Please refer here to know about the limits in detail.

• DEPENDENT_FIELD_MISSINGHTTP 400

  One or more dependent fields are missing
  Resolution: Specify all the dependent fields in the input body. Please refer above to the Input JSON Keys.

• EXPECTED_FIELD_MISSINGHTTP 404

  One or more expected fields missing
  Resolution: Specify the dependent keys of a field. Refer above to the Input JSON Keys.

• AMBIGUITY_DURING_PROCESSINGHTTP 400
  • The ID given in the request body does not belong to the respective module which you are trying to create.
  • Cannot provide both picklist options and global set

  Resolutions:

  • Specify the required field with its valid module API name and ID.
  • Please specify the global picklist JSON object. You cannot simultaneously provide both the picklist options JSON array and the global picklist JSON object.
• EXPECTED_DEPENDENT_FIELD_MISSINGHTTP 400

  Either global_picklist or picklist values is expected 
  Resolution:

  Provide dependent fields to create a picklist or global picklist field in a layout. Refer to the Create Custom Field API for more information.

• DUPLICATE_DATAHTTP 400
  • Duplicate field label
  • Duplicate display_value has been found among the picklist options
  • Duplicate API name has been found for a field creation

  Resolutions:

  • The field label seems to be a duplicate. Specify a unique field label.
  • One or more picklist option values have been found to be the same. Please specify a unique display value.
  • Specify a unique API name for a field.
• MANDATORY_NOT_FOUNDHTTP 400

  Required fields not found
  Resolution: One or more mandatory fields are missing for the fields you are trying to create. Please refer above to the Input JSON Keys.

• RESERVED_KEYWORD_NOT_ALLOWEDHTTP 400

  System-defined keywords not allowed in the API name
  Resolution: Specify a non-system-defined keyword for the API name.

• RESERVED_KEYWORD_NOT_ALLOWEDHTTP 400

  External field is not allowed for module Calls.

• REQUIRED_PARAM_MISSINGHTTP 400

  Required parameter is missing

  Resolution: Please specify the module parameter and its corresponding value.

• INVALID_REQUEST_METHODHTTP 400

  The http request method type is not a valid one
  Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to the endpoints section above.

• OAUTH_SCOPE_MISMATCHHTTP 401

  Unauthorized
  Resolution: The client does not have a valid scope to create custom fields. Create a new token with valid scope. Refer to scope section above.

• AUTHENTICATION_FAILUREHTTP 401

  Authentication failed
  Resolution: Pass the access token in the request header of the API call.

• NOT_SUPPORTEDHTTP 403

  Encryptions is not supported for the requested data type 
  Resolution:

  The requested field type is not supported for the crypt key. Please specify the allowed field data types. Please refer the crypt key in the above Input JSON Keys to know the allowed field data types.

• INVALID_URL_PATTERNHTTP 404

  Please check if the URL trying to access is a correct one
  Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to the request URL section above.

• INTERNAL_ERRORHTTP 500

  Internal Server Error
  Resolution: Unexpected and unhandled exception in the server. Contact support team.