Добавить пользовательское поле user.userfield.add
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
user.userfieldКто может выполнять метод: администратор
Метод user.userfield.add создает пользовательское поле в профиле сотрудника и возвращает его идентификатор. К коду FIELD_NAME автоматически добавляется префикс UF_USR_, тип и множественность поля после создания изменить нельзя.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
fields* |
Значения полей для добавления нового пользовательского поля |
Параметр fields
Обязательные параметры отмечены *
|
Название |
Описание |
|
FIELD_NAME* |
Название (код) поля. Битрикс24 приводит его к верхнему регистру и дополняет префиксом
Итоговый код поля возвращает метод user.userfield.list |
|
USER_TYPE_ID* |
Тип пользовательского поля. После создания тип изменить нельзя. Возможные значения:
|
|
XML_ID |
Внешний код |
|
SORT |
Порядок сортировки |
|
MULTIPLE |
Является ли поле множественным. После создания изменить нельзя. Возможные значения:
По умолчанию |
|
SHOW_FILTER |
Показывать ли поле в фильтре списка. Возможные значения:
По умолчанию |
|
SETTINGS |
Дополнительные настройки поля. Набор зависит от типа |
|
LIST |
Варианты значений для поля типа |
|
Подпись в форме редактирования. Можно передать строку или объект с подписями по языкам в формате |
|
|
Заголовок столбца в списке. Можно передать строку или объект с подписями по языкам в формате |
|
|
Заголовок фильтра в списке. Можно передать строку или объект с подписями по языкам в формате |
|
|
Сообщение об ошибке при невалидном вводе. Можно передать строку или объект с текстами по языкам в формате |
|
|
Текст подсказки к полю. Можно передать строку или объект с текстами по языкам в формате |
|
|
LABEL |
Название пользовательского поля по умолчанию. Значение будет выставлено в поля |
Параметры MANDATORY, SHOW_IN_LIST, EDIT_IN_LIST и IS_SEARCHABLE метод не принимает и игнорирует без ошибки. Поле всегда создается со значениями MANDATORY = N, SHOW_IN_LIST = Y, EDIT_IN_LIST = Y, IS_SEARCHABLE = N.
Параметр SETTINGS
У каждого типа пользовательских полей существует свой набор дополнительных настроек.
|
Название |
Описание |
|
DEFAULT_VALUE |
Значение по умолчанию. По умолчанию |
|
ROWS |
Количество строк в поле ввода. Обязательно больше 0. По умолчанию |
|
Название |
Описание |
|
DEFAULT_VALUE |
Значение по умолчанию |
|
Название |
Описание |
|
DEFAULT_VALUE |
Значение по умолчанию |
|
PRECISION |
Точность числа. Обязательно больше или равно 0. По умолчанию |
|
Название |
Описание |
|
DEFAULT_VALUE |
Значение по умолчанию, где Возможные значения:
По умолчанию |
|
DISPLAY |
Внешний вид. Возможные значения:
По умолчанию |
|
Название |
Описание |
|
DEFAULT_VALUE |
Значение по умолчанию. Объект формата:
где:
Значение по умолчанию:
|
|
Название |
Описание |
|
DISPLAY |
Внешний вид. Возможные значения:
По умолчанию |
|
LIST_HEIGHT |
Высота списка. Обязательно больше 0. Доступен только при По умолчанию |
|
Название |
Описание |
|
IBLOCK_TYPE_ID |
Идентификатор типа инфоблока. По умолчанию |
|
IBLOCK_ID |
Идентификатор инфоблока. По умолчанию |
|
DEFAULT_VALUE |
Значение по умолчанию. По умолчанию |
|
DISPLAY |
Внешний вид. Возможные значения:
По умолчанию |
|
LIST_HEIGHT |
Высота списка. Обязательно больше 0. По умолчанию |
|
ACTIVE_FILTER |
Показывать ли элементы с включенным флагом активности. Возможные значения:
По умолчанию |
|
Название |
Описание |
|
ENTITY_TYPE |
Идентификатор типа справочника. Используйте По умолчанию |
Если не передать ни одну из следующих опций, то по умолчанию будет включена привязка к лидам (LEAD = Y).
|
Название |
Описание |
|
LEAD |
Включена ли привязка к Лидам. Возможные значения:
По умолчанию |
|
CONTACT |
Включена ли привязка к Контактам. Возможные значения:
По умолчанию |
|
COMPANY |
Включена ли привязка к Компаниям. Возможные значения:
По умолчанию |
|
DEAL |
Включена ли привязка к Сделкам. Возможные значения:
По умолчанию |
Для типов file, url, address, money и employee метод не принимает SETTINGS: переданные настройки игнорируются, поле получает системные настройки по умолчанию. Для поля типа employee значение SHOW_FILTER = Y сохраняется как I — фильтр по точному совпадению.
Параметр LIST
Варианты значений для поля типа enumeration. Передается в fields как массив объектов.
Обязательные параметры отмечены *
|
Название |
Описание |
|
VALUE* |
Текст варианта. Варианты с пустым |
|
SORT |
Порядок варианта в списке |
|
DEF |
Вариант по умолчанию:
Для поля с |
|
XML_ID |
Внешний код варианта. Если не передан, генерируется автоматически |
Если необходимо через API создать пользовательское поле с добавленным пользовательским типом, в поле USER_TYPE_ID необходимо указывать rest_<номер приложения>_<USER_TYPE_ID добавленного типа>. Например rest_436278_test_type.
Поле добавляется в профили всех сотрудников, поэтому в Битрикс24 с большим числом пользователей запрос выполняется долго и может прерваться по таймауту. Подробнее в разделе Частые причины серверных ошибок.
Примеры кода
Как использовать примеры в документации
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",
"EDIT_FORM_LABEL": {
"ru": "Привязка к сделкам CRM"
}
}
}' \
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",
"EDIT_FORM_LABEL": {
"ru": "Привязка к сделкам CRM"
}
},
"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": "Привязка к сделкам CRM",
"EDIT_FORM_LABEL": {
"ru": "Привязка к сделкам CRM",
},
},
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {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',
'EDIT_FORM_LABEL' => [
'ru' => 'Привязка к сделкам CRM'
],
]
]
);
$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",
EDIT_FORM_LABEL: {
ru: "Привязка к сделкам CRM"
},
},
},
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',
'EDIT_FORM_LABEL' => [
'ru' => 'Привязка к сделкам CRM'
],
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
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",
"EDIT_FORM_LABEL": b24.Params{
"ru": "Привязка к сделкам CRM",
},
},
})
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("разбор ответа: %w", err)
}
fmt.Println("идентификатор:", newID)
Обработка ответа
HTTP-статус: 200
{
"result": 6008111,
"time": {
"start": 1793288724,
"finish": 1793288724.469025,
"duration": 0.4690248966217041,
"processing": 0,
"date_start": "2026-10-29T18:45:24+03:00",
"date_finish": "2026-10-29T18:45:24+03:00",
"operating_reset_at": 1793289240,
"operating": 0.11251688003540039
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Идентификатор созданного пользовательского поля |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error":"",
"error_description":"The \u0027FIELD_NAME\u0027 field is not found."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
|
Поле UF_USR_*** для объекта USER уже существует. |
Поле с таким |
|
|
|
Указан неверный пользовательский тип. |
В |
|
|
|
Fail to create new user field |
Ошибка при создании поля |
|
|
Пустая строка |
The \u0027FIELD_NAME\u0027 field is not found. |
Не задано обязательное поле |
|
|
Пустая строка |
The \u0027USER_TYPE_ID\u0027 field is not found. |
Не задано обязательное поле |
|
|
Пустая строка |
Access denied. |
У пользователя нет прав администратора |
|
|
|
The request requires higher privileges than provided by the webhook token |
У вебхука или приложения нет scope |
|
|
|
Internal server error |
Превышен лимит в 1016 пользовательских полей или запрос не успел выполниться за время |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Приложение Маркетплейса заблокировано, потому что число установленных приложений превышает лимит тарифа. События такому приложению не доставляются. Приложения, освобожденные от лимита, не блокируются |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |