Обновить пользовательское поле userfieldconfig.update

Scope: userfieldconfig, scope модуля из moduleId (например, crm)

Кто может выполнять метод: пользователь с правом изменения настроек объекта в модуле moduleId (для crm — право «Разрешить изменять настройки»)

Метод userfieldconfig.update обновляет настройки существующего пользовательского поля.

Параметры метода

Обязательные параметры отмечены *

Название `тип`	Описание
moduleId* `string`	Идентификатор модуля, в котором находится поле
id* `integer`	Идентификатор настроек пользовательского поля
field* `object`	Объект с новыми настройками поля (подробное описание)

Параметр field

Название `тип`	Описание
xmlId `string`	Внешний идентификатор поля
sort `integer`	Индекс сортировки
mandatory `boolean`	Флаг обязательного поля (`Y`/`N`)
showFilter `boolean`	Флаг показа поля в фильтре (`Y`/`N`)
isSearchable `boolean`	Флаг участия поля в поиске (`Y`/`N`)
editFormLabel `lang_map`	Подписи в форме редактирования по языкам
helpMessage `lang_map`	Текст подсказки по языкам
settings `object`	Дополнительные настройки поля. Набор ключей зависит от типа поля (подробное описание)
enum `uf_enum_element[]`	Список вариантов значений для поля типа `enumeration`. Чтобы изменения `enum` применились, в `field.userTypeId` нужно передать `enumeration`
userTypeId `string`	Тип поля. Используется при обновлении `enum`, в этом случае передайте `enumeration`

Параметр settings

У каждого типа поля существует свой набор ключей в settings.

string

integer

double

boolean

date|datetime

money

url

address

file

enumeration

iblock_section|iblock_element

crm_status

crm

employee

rest_*

Название `тип`	Описание
DEFAULT_VALUE `string`	Значение по умолчанию
ROWS `integer`	Количество строк в поле ввода, должно быть больше 0
SIZE `integer`	Ширина поля ввода
REGEXP `string`	Регулярное выражение для валидации
MIN_LENGTH `integer`	Минимальная длина строки
MAX_LENGTH `integer`	Максимальная длина строки

Название `тип`	Описание
DEFAULT_VALUE `integer`	Значение по умолчанию
SIZE `integer`	Ширина поля ввода
MIN_VALUE `integer`	Минимальное значение
MAX_VALUE `integer`	Максимальное значение

Название `тип`	Описание
DEFAULT_VALUE `double`	Значение по умолчанию
PRECISION `integer`	Точность числа, должна быть больше или равна 0
SIZE `integer`	Ширина поля ввода
MIN_VALUE `double`	Минимальное значение
MAX_VALUE `double`	Максимальное значение

Название `тип`	Описание
DEFAULT_VALUE `integer`	Значение по умолчанию, где `1` = да и `0` = нет
DISPLAY `string`	Внешний вид, возможные значения: `CHECKBOX`, `RADIO`, `DROPDOWN`
LABEL `string`	Подпись значения Да
LABEL_CHECKBOX `string`	Подпись для режима `CHECKBOX`

Название `тип`	Описание
DEFAULT_VALUE `object`	Значение по умолчанию в формате `{VALUE, TYPE}`, где `TYPE`: `NONE`, `NOW`, `FIXED`
USE_SECOND `boolean`	Использовать секунды в поле `datetime`
USE_TIMEZONE `boolean`	Использовать часовой пояс в поле `datetime`

Название `тип`	Описание
DEFAULT_VALUE `string`	Значение по умолчанию в формате `	{CURRENCY}`

Название `тип`	Описание
POPUP `boolean`	Открывать ссылку в новом окне
SIZE `integer`	Ширина поля ввода
MIN_LENGTH `integer`	Минимальная длина значения
MAX_LENGTH `integer`	Максимальная длина значения
DEFAULT_VALUE `string`	Значение по умолчанию
ROWS `integer`	Количество строк в поле ввода

Название `тип`	Описание
SHOW_MAP `boolean`	Показывать карту для адреса

Название `тип`	Описание
SIZE `integer`	Ширина поля ввода
LIST_WIDTH `integer`	Ширина превью в списке
LIST_HEIGHT `integer`	Высота превью в списке
MAX_SHOW_SIZE `integer`	Максимальный размер файла для показа
MAX_ALLOWED_SIZE `integer`	Максимально допустимый размер файла
EXTENSIONS `string[]`	Список разрешенных расширений
TARGET_BLANK `boolean`	Открывать файл в новой вкладке

Название `тип`	Описание
DISPLAY `string`	Внешний вид, возможные значения: `LIST`, `UI`, `CHECKBOX`, `DIALOG`
LIST_HEIGHT `integer`	Высота списка, должна быть больше 0
CAPTION_NO_VALUE `string`	Подпись пустого значения
SHOW_NO_VALUE `boolean`	Показывать пустое значение

Название `тип`	Описание
DISPLAY `string`	Внешний вид, возможные значения: `DIALOG`, `UI`, `LIST`, `CHECKBOX`
LIST_HEIGHT `integer`	Высота списка, должна быть больше 0
IBLOCK_ID `integer`	Идентификатор инфоблока
DEFAULT_VALUE `string`	Значение по умолчанию
ACTIVE_FILTER `boolean`	Использовать только активные элементы

Название `тип`	Описание
ENTITY_TYPE `string`	Идентификатор типа справочника CRM. Возможные значения можно получить методом `crm.status.entity.types`

Название `тип`	Описание
LEAD `boolean`	Включить привязку к лидам
CONTACT `boolean`	Включить привязку к контактам
COMPANY `boolean`	Включить привязку к компаниям
DEAL `boolean`	Включить привязку к сделкам
QUOTE `boolean`	Включить привязку к предложениям
ORDER `boolean`	Включить привязку к заказам
SMART_INVOICE `boolean`	Включить привязку к счетам
DYNAMIC_* `boolean`	Включить привязку к смарт-процессу с конкретным `typeId`

Отдельные настройки в settings для типа employee не используются

Настройки определяются обработчиком пользовательского типа поля

Тип uf_enum_element

Название `тип`	Описание
id `integer`	Идентификатор существующего варианта. Используется для обновления или удаления
value `string`	Значение варианта
def `boolean`	Флаг значения по умолчанию (`Y`/`N`)
sort `integer`	Индекс сортировки
xmlId `string`	Внешний идентификатор варианта
del `boolean`	Флаг удаления существующего варианта (`Y`/`N`)

Некоторые параметры поля нельзя изменить после создания. Если передать их в field, изменение не будет применено

Примеры кода

Как использовать примеры в документации

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"moduleId":"crm","id":7095,"field":{"mandatory":"Y","editFormLabel":{"ru":"Список характеристик (обновлено)","en":"List of characteristics (updated)"}}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/userfieldconfig.update

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"moduleId":"crm","id":7095,"field":{"mandatory":"Y","editFormLabel":{"ru":"Список характеристик (обновлено)","en":"List of characteristics (updated)"}},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/userfieldconfig.update

try
        {
        	const response = await $b24.callMethod(
        		'userfieldconfig.update',
        		{
        			moduleId: 'crm',
        			id: 7095,
        			field: {
        				mandatory: 'Y',
        				editFormLabel: {
        					ru: 'Список характеристик (обновлено)',
        					en: 'List of characteristics (updated)',
        				},
        			},
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'userfieldconfig.update',
                    [
                        'moduleId' => 'crm',
                        'id' => 7095,
                        'field' => [
                            'mandatory' => 'Y',
                            'editFormLabel' => [
                                'ru' => 'Список характеристик (обновлено)',
                                'en' => 'List of characteristics (updated)',
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Result: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }

BX24.callMethod(
            'userfieldconfig.update',
            {
                moduleId: 'crm',
                id: 7095,
                field: {
                    mandatory: 'Y',
                    editFormLabel: {
                        ru: 'Список характеристик (обновлено)',
                        en: 'List of characteristics (updated)',
                    },
                },
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
            'userfieldconfig.update',
            [
                'moduleId' => 'crm',
                'id' => 7095,
                'field' => [
                    'mandatory' => 'Y',
                    'editFormLabel' => [
                        'ru' => 'Список характеристик (обновлено)',
                        'en' => 'List of characteristics (updated)',
                    ],
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Обработка ответа

HTTP-статус: 200

{
            "result": {
                "field": {
                    "id": "7095",
                    "entityId": "CRM_7",
                    "fieldName": "UF_CRM_7_NEW_REST_LIST_2026",
                    "userTypeId": "enumeration",
                    "xmlId": null,
                    "sort": "100",
                    "multiple": "Y",
                    "mandatory": "Y",
                    "showFilter": "N",
                    "showInList": "Y",
                    "editInList": "Y",
                    "isSearchable": "N",
                    "settings": {
                        "DISPLAY": "LIST",
                        "LIST_HEIGHT": 1,
                        "CAPTION_NO_VALUE": "",
                        "SHOW_NO_VALUE": "Y"
                    },
                    "languageId": {
                        "en": "en",
                        "ru": "ru"
                    },
                    "editFormLabel": {
                        "en": "List of characteristics (updated)",
                        "ru": "Список характеристик (обновлено)"
                    },
                    "listColumnLabel": {
                        "en": null,
                        "ru": null
                    },
                    "listFilterLabel": {
                        "en": null,
                        "ru": null
                    },
                    "errorMessage": {
                        "en": null,
                        "ru": null
                    },
                    "helpMessage": {
                        "en": null,
                        "ru": null
                    },
                    "enum": [
                        {
                            "id": "3671",
                            "userFieldId": "7095",
                            "value": "Характеристика 1",
                            "def": "N",
                            "sort": "100",
                            "xmlId": "38a8c98a5de02f8ccdca2244e5065ecd"
                        },
                        {
                            "id": "3673",
                            "userFieldId": "7095",
                            "value": "Характеристика 2",
                            "def": "Y",
                            "sort": "200",
                            "xmlId": "9520e17b39f3525b820b809914b52207"
                        }
                    ]
                }
            },
            "time": {
                "start": 1774356026,
                "finish": 1774356026.949068,
                "duration": 0.9490680694580078,
                "processing": 0,
                "date_start": "2026-03-24T15:40:26+03:00",
                "date_finish": "2026-03-24T15:40:26+03:00",
                "operating_reset_at": 1774356626,
                "operating": 0
            }
        }

Возвращаемые данные

Название `тип`	Описание
result `object`	Корневой элемент ответа (подробное описание)
time `time`	Информация о времени выполнения запроса

Объект result

Название `тип`	Описание
field `object`	Настройки обновленного пользовательского поля (подробное описание)

Объект field

Название `тип`	Описание
id `integer`	Идентификатор настроек поля
entityId `string`	Идентификатор объекта
fieldName `string`	Код поля
userTypeId `string`	Идентификатор типа поля
xmlId `string`	Внешний идентификатор поля
sort `integer`	Индекс сортировки
multiple `boolean`	Флаг множественного значения (`Y`/`N`)
mandatory `boolean`	Флаг обязательного поля (`Y`/`N`)
showFilter `boolean`	Флаг показа поля в фильтре
showInList `boolean`	Флаг показа поля в списке
editInList `boolean`	Флаг редактирования в списке
isSearchable `boolean`	Флаг участия в поиске
settings `object`	Дополнительные настройки поля. См. Параметр settings. Состав ключей зависит от `userTypeId`
languageId `object`	Языки, для которых заданы подписи поля
editFormLabel `lang_map`	Подписи в форме редактирования
listColumnLabel `lang_map`	Подписи колонки в списке
listFilterLabel `lang_map`	Подписи в фильтре
errorMessage `lang_map`	Текст сообщения об ошибке
helpMessage `lang_map`	Подсказка по полю
enum `object[]`	Варианты значений. Поле возвращается только для `userTypeId = enumeration`

Обработка ошибок

HTTP-статус: 400

{
            "error": "",
            "error_description": "Вы не можете изменить настройки пользьовательского поля"
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код	Описание	Значение
`-`	Вы не можете изменить настройки пользовательского поля	Недостаточно прав на изменение поля. Эта же ошибка возвращается, если поле с переданным `id` уже удалено или недоступно в контексте `moduleId`
`-`	The current method required more scopes. (crm)	У приложения нет нужного scope для модуля из `moduleId`
`-`	No settings for UserFieldAccess	Для переданного `moduleId` не настроен доступ к пользовательским полям
`-`	Ошибка при попытке изменения настроек пользовательских полей	Общая ошибка изменения поля

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Получить список настроек пользовательских полей

Обзор методов

Обновить пользовательское поле userfieldconfig.update

Параметры методаПараметры метода

Параметр fieldПараметр field

Параметр settingsПараметр settings

Тип uf_enum_elementТип uf_enum_element

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

Возвращаемые данныеВозвращаемые данные

Объект resultОбъект result

Объект fieldОбъект field

Обработка ошибокОбработка ошибок

Возможные коды ошибокВозможные коды ошибок

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение