Custom Fields: Overview of Methods

In Bitrix24, you can configure custom fields for employees. This allows you to supplement the standard information about users.

Quick navigation: all methods

Types of Custom FieldsTypes of Custom Fields

For each custom field, a type is specified: String, List, Number, CRM element binding, and others. A complete list of field types is described in the fields parameter of the user.userfield.add method.

Linking Custom Fields with Other ObjectsLinking Custom Fields with Other Objects

Currencies. In the Money type field, you specify a number and a currency. You can work with currencies through the crm.currency.* methods.

User. In a custom field, you can set a binding to an employee. You can obtain the user ID using the user.get and user.search methods.

Information Blocks. Custom fields can be linked to products, workflows, and lists through the Info block element binding and Info block section binding types.

Files. The File type field allows you to upload and store files. Files do not receive IDs in the Drive module, so Drive methods are not applicable. You can only work with files through the Bitrix24 interface.

CRM. Custom fields can be linked to CRM objects using two types.

• CRM element binding — for linking with leads, deals, contacts, and companies.

• CRM directory binding — for selection from the list of CRM directories.

Errors When Working with Custom FieldsErrors When Working with Custom Fields

When creating or deleting custom fields, the request may be interrupted with an INTERNAL_SERVER_ERROR. This is an internal server error. The cause of the error can be found in the server logs at the time of the request.

• Cloud Bitrix24 — contact technical support to get details about the error.

• On-premise Bitrix24 — request the server error log from the server or hosting administrator. Then, contact technical support and attach the log for analysis.

Common Causes of Server ErrorsCommon Causes of Server Errors

1. You can create 1016 custom fields for users — this is a database architecture limitation. If the limit is reached, attempting to create a new field will return an INTERNAL_SERVER_ERROR from the user.userfield.add method.

   You can check the number of custom fields using the user.userfield.list method.

2. There is a limitation on servers for the execution time of a single request — max_execution_time. The default value is 60 seconds. If the request takes longer, it is interrupted with an INTERNAL_SERVER_ERROR.

   The time for creating or deleting a custom field depends on the number of users. When a field is created, it is added to all employee profiles. When a field is deleted, it is removed from all profiles. The fewer users in your Bitrix24, the faster the fields will be created and deleted.

   You can check the number of users in Bitrix24 using the user.get method.

Overview of MethodsOverview of Methods

Scope: user.userfield

Who can perform the method: depending on the method

Method	Description
user.userfield.add	Adds a custom field
user.userfield.update	Updates a custom field
user.userfield.delete	Deletes a custom field
user.userfield.list	Retrieves a list of custom fields