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

userfieldconfig.update

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

Кто может выполнять: пользователь с правом изменения настроек объекта в модуле 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

Тип uf_enum_element

id integer необязательный

Идентификатор существующего варианта. Используется для обновления или удаления

value string необязательный

Значение варианта

def boolean необязательный

Флаг значения по умолчанию (Y/N)

sort integer необязательный

Индекс сортировки

xmlId string необязательный

Внешний идентификатор варианта

del boolean необязательный

Флаг удаления существующего варианта (Y/N)

Примеры запроса

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

Ответ

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

Информация о времени выполнения запроса

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

HTTP-статус: 400

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

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.