Custom Fields in CRM: Overview of Methods

Custom fields allow you to extend CRM cards to fit your own processes: adding additional attributes, storing internal classifiers, and transferring data between the CRM and external systems.

This section describes universal methods that help understand the structure of a custom field: its characteristics, types, settings, and format of list values. These methods do not create a field in the object card but return reference information for configuring the field.

Quick navigation: all methods

User documentation: Custom Fields in CRM

Connection of Custom Fields with CRM ObjectsConnection of Custom Fields with CRM Objects

CRM Objects. Object methods crm.*.userfield.* use reference information from this section for leads, deals, contacts, companies, estimates, and requisites.

Key TermsKey Terms

• ENTITY_ID — code of the CRM object to which the field is linked
• FIELD_NAME — code of the custom field in the format UF_CRM_*
• USER_TYPE_ID — data type of the custom field; a complete list of values is returned by crm.userfield.types
• SETTINGS — field settings that depend on the selected type
• LIST — set of elements for the enumeration type field

How to Get StartedHow to Get Started

1. Identify the CRM object for which you need to add a field and open its section crm.*.userfield.*. For example, crm.lead.userfield.*, crm.deal.userfield.*, crm.contact.userfield.*.
2. Retrieve available types through crm.userfield.types and select the appropriate USER_TYPE_ID.
3. Obtain the field structure via crm.userfield.fields to check the required characteristics.
4. For the selected type, get the settings through crm.userfield.settings.fields, where the type parameter for standard types matches USER_TYPE_ID.
5. If the type is enumeration, check the format of list elements through crm.userfield.enumeration.fields.
6. After that, create or update the field in the object section.

Overview of MethodsOverview of Methods

Scope: crm

Who can execute the method: any user

Method	Description
crm.userfield.types	Returns a list of custom field types
crm.userfield.fields	Returns a description of custom field characteristics
crm.userfield.settings.fields	Returns a description of settings fields for the specified type
crm.userfield.enumeration.fields	Returns a description of fields for the custom field of type enumeration