Add custom field user.userfield.add
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
user.userfieldWho can execute the method: administrator
The user.userfield.add method creates a custom field in the employee profile and returns its ID. The UF_USR_ prefix is automatically added to the FIELD_NAME code. The type and multiplicity of the field cannot be changed after it is created.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
Field values for adding a new custom field |
Parameter fields
Required parameters are marked with *
|
Name |
Description |
|
FIELD_NAME* |
Field name (code). Bitrix24 converts it to uppercase and supplements it with the
The resulting field code is returned by the user.userfield.list method |
|
USER_TYPE_ID* |
Custom field type. The type cannot be changed after the field is created. Possible values:
|
|
XML_ID |
External code |
|
SORT |
Sort order |
|
MULTIPLE |
Whether the field is multiple. Cannot be changed after the field is created. Possible values:
Default is |
|
SHOW_FILTER |
Whether to show the field in the list filter. Possible values:
Default is |
|
SETTINGS |
Additional field settings. The set depends on the |
|
LIST |
Value options for an |
|
Label in the editing form. You can pass a string or an object with labels by language in |
|
|
Column header in the list. You can pass a string or an object with labels by language in |
|
|
Filter header in the list. You can pass a string or an object with labels by language in |
|
|
Error message for invalid input. You can pass a string or an object with texts by language in |
|
|
Tooltip text for the field. You can pass a string or an object with texts by language in |
|
|
LABEL |
Default custom field name. The value will be set in fields |
The method does not accept the MANDATORY, SHOW_IN_LIST, EDIT_IN_LIST, and IS_SEARCHABLE parameters and ignores them without an error. The field is always created with MANDATORY = N, SHOW_IN_LIST = Y, EDIT_IN_LIST = Y, IS_SEARCHABLE = N.
Parameter SETTINGS
Each custom field type has its own set of additional configurations.
|
Name |
Description |
|
DEFAULT_VALUE |
Default value. Default |
|
ROWS |
Number of lines in the input field. Must be greater than 0. Default |
|
Name |
Description |
|
DEFAULT_VALUE |
Default value |
|
Name |
Description |
|
DEFAULT_VALUE |
Default value |
|
PRECISION |
Number precision. Must be greater than or equal to 0. Default |
|
Name |
Description |
|
DEFAULT_VALUE |
Default value, where Possible values:
Default |
|
DISPLAY |
Appearance. Possible values:
Default |
|
Name |
Description |
|
DEFAULT_VALUE |
Default value. Object format:
where:
Default value:
|
|
Name |
Description |
|
DISPLAY |
Appearance. Possible values:
Default |
|
LIST_HEIGHT |
List height. Must be greater than 0. Available only when Default |
|
Name |
Description |
|
IBLOCK_TYPE_ID |
Infoblock type identifier. Default |
|
IBLOCK_ID |
Information block identifier. Default |
|
DEFAULT_VALUE |
Default value. Default |
|
DISPLAY |
Appearance. Possible values:
Default |
|
LIST_HEIGHT |
List height. Must be greater than 0. Default |
|
ACTIVE_FILTER |
Whether to show items with the activity flag enabled. Possible values:
Default is |
|
Name |
Description |
|
ENTITY_TYPE |
Directory type identifier. Use Default |
If none of the following options are passed, linking to leads (LEAD = Y) will be enabled by default.
|
Name |
Description |
|
LEAD |
Whether binding to Leads is enabled. Possible values:
Default is |
|
CONTACT |
Whether binding to Contacts is enabled. Possible values:
Default is |
|
COMPANY |
Whether binding to Companies is enabled. Possible values:
Default is |
|
DEAL |
Whether binding to Deals is enabled. Possible values:
Default is |
For file, url, address, money, and employee fields, the method does not accept SETTINGS: the passed settings are ignored, and the field gets the default system settings. For an employee field, the SHOW_FILTER = Y value is saved as I, an exact match filter.
Parameter LIST
Value options for an enumeration field. Passed in fields as an array of objects.
Required parameters are marked with *
|
Name |
Description |
|
VALUE* |
Option text. Options with an empty |
|
SORT |
Option order in the list |
|
DEF |
Default option:
For a field with |
|
XML_ID |
External code of the option. If not passed, it is generated automatically |
If it is necessary to create a custom field with an added custom type via the API, you must specify rest_<app_number>_<added_type_USER_TYPE_ID> in the USER_TYPE_ID field. For example, rest_436278_test_type.
The field is added to the profiles of all employees, so in a Bitrix24 account with many users the request takes a long time and may be interrupted by a timeout. For more details, see Common Causes of Server Errors.
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields": {
"FIELD_NAME": "UF_USR_DEALS",
"USER_TYPE_ID": "crm",
"XML_ID": "UF_CRM_DEALS",
"SORT": 100,
"MULTIPLE": "Y",
"SHOW_FILTER": "N",
"SETTINGS": {
"DEAL": "Y"
},
"LABEL": "CRM Deal Linking",
"EDIT_FORM_LABEL": {
"de": "CRM Deal Linking"
}
}
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/user.userfield.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields": {
"FIELD_NAME": "UF_USR_DEALS",
"USER_TYPE_ID": "crm",
"XML_ID": "UF_CRM_DEALS",
"SORT": 100,
"MULTIPLE": "Y",
"SHOW_FILTER": "N",
"SETTINGS": {
"DEAL": "Y"
},
"LABEL": "CRM Deal Linking",
"EDIT_FORM_LABEL": {
"de": "CRM Deal Linking"
}
},
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/user.userfield.add
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type AddUserFieldResult = number
try {
const response = await $b24.actions.v2.call.make<AddUserFieldResult>({
method: 'user.userfield.add',
params: {
fields: {
FIELD_NAME: 'UF_USR_DEALS',
USER_TYPE_ID: 'crm',
XML_ID: 'UF_CRM_DEALS',
SORT: 100,
MULTIPLE: 'Y',
SHOW_FILTER: 'N',
SETTINGS: {
DEAL: 'Y',
},
LABEL: 'CRM deals binding',
EDIT_FORM_LABEL: {
ru: 'CRM deals binding',
},
},
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Created user field with ID:', result)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function addUserField() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'user.userfield.add',
params: {
fields: {
FIELD_NAME: 'UF_USR_DEALS',
USER_TYPE_ID: 'crm',
XML_ID: 'UF_CRM_DEALS',
SORT: 100,
MULTIPLE: 'Y',
SHOW_FILTER: 'N',
SETTINGS: {
DEAL: 'Y',
},
LABEL: 'CRM deals binding',
EDIT_FORM_LABEL: {
ru: 'CRM deals binding',
},
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Created user field with ID:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addUserField)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.user.userfield.add(
fields={
"FIELD_NAME": "UF_USR_DEALS",
"USER_TYPE_ID": "crm",
"XML_ID": "UF_CRM_DEALS",
"SORT": 100,
"MULTIPLE": "Y",
"SHOW_FILTER": "N",
"SETTINGS": {
"DEAL": "Y",
},
"LABEL": "Linking to CRM deals",
"EDIT_FORM_LABEL": {
"ru": "Linking to CRM deals",
},
},
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
try {
$response = $b24Service
->core
->call(
'user.userfield.add',
[
'fields' => [
'FIELD_NAME' => 'UF_USR_DEALS',
'USER_TYPE_ID' => 'crm',
'XML_ID' => 'UF_CRM_DEALS',
'SORT' => 100,
'MULTIPLE' => 'Y',
'SHOW_FILTER' => 'N',
'SETTINGS' => [
'DEAL' => 'Y',
],
'LABEL' => 'CRM Deal Linking',
'EDIT_FORM_LABEL' => [
'de' => 'CRM Deal Linking'
],
]
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding user field: ' . $e->getMessage();
}
BX24.callMethod(
'user.userfield.add',
{
fields: {
FIELD_NAME: "UF_USR_DEALS",
USER_TYPE_ID: "crm",
XML_ID: "UF_CRM_DEALS",
SORT: 100,
MULTIPLE: "Y",
SHOW_FILTER: "N",
SETTINGS: {
DEAL: "Y",
},
LABEL: "CRM Deal Linking",
EDIT_FORM_LABEL: {
ru: "CRM Deal Linking"
},
},
},
function(result)
{
if(result.error())
console.error(result.error());
else
console.log(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'user.userfield.add',
[
'fields' => [
'FIELD_NAME' => 'UF_USR_DEALS',
'USER_TYPE_ID' => 'crm',
'XML_ID' => 'UF_CRM_DEALS',
'SORT' => 100,
'MULTIPLE' => 'Y',
'SHOW_FILTER' => 'N',
'SETTINGS' => [
'DEAL' => 'Y',
],
'LABEL' => 'CRM Deal Linking',
'EDIT_FORM_LABEL' => [
'de' => 'CRM Deal Linking'
],
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "user.userfield.add", b24.Params{
"fields": b24.Params{
"FIELD_NAME": "UF_USR_DEALS",
"USER_TYPE_ID": "crm",
"XML_ID": "UF_CRM_DEALS",
"SORT": 100,
"MULTIPLE": "Y",
"SHOW_FILTER": "N",
"SETTINGS": b24.Params{
"DEAL": "Y",
},
"LABEL": "CRM Deal Linking",
"EDIT_FORM_LABEL": b24.Params{
},
},
})
if err != nil {
return fmt.Errorf("user.userfield.add: %w", err)
}
var newID b24.ID
if err := json.Unmarshal(res.Result, &newID); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println("id:", newID)
Response Handling
HTTP status: 200
{
"result": 6008111,
"time": {
"start": 1793288724,
"finish": 1793288724.469025,
"duration": 0.4690248966217041,
"processing": 0,
"date_start": "2026-10-29T18:45:24+01:00",
"date_finish": "2026-10-29T18:45:24+01:00",
"operating_reset_at": 1793289240,
"operating": 0.11251688003540039
}
}
Returned Data
|
Name |
Description |
|
result |
Identifier of the created custom field |
|
time |
Request execution time information |
Error Handling
HTTP status: 400
{
"error":"",
"error_description":"The \u0027FIELD_NAME\u0027 field is not found."
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Status |
Code |
Description |
Value |
|
|
|
The field UF_USR_*** for entity USER already exists. |
A field with this |
|
|
|
The custom type is invalid. |
The |
|
|
|
Fail to create new user field |
Error while creating field |
|
|
Empty string |
The \u0027FIELD_NAME\u0027 field is not found. |
Mandatory field |
|
|
Empty string |
The \u0027USER_TYPE_ID\u0027 field is not found. |
Mandatory field |
|
|
Empty string |
Access denied. |
The user does not have administrator permissions |
|
|
|
The request requires higher privileges than provided by the webhook token |
The webhook or application does not have the |
|
|
|
Internal server error |
The limit of 1016 custom fields is exceeded, or the request did not complete within |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |