метод REST scope: user.userfield

user.userfield.update

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

Кто может выполнять: администратор

Описание

Метод user.userfield.update обновляет пользовательское поле.

Параметры

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

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

Для получения идентификаторов пользовательских полей используйте метод user.userfield.list

fields object необязательный

Значения полей для обновления пользовательского поля

Параметр fields

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

Внешний код

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

Порядок сортировки

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

Является ли пользовательское поле обязательным. Возможные значения:
- Y — да
- N — нет

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

Показывать ли поле в фильтре списка. Возможные значения:
- Y — да
- N — нет

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

Показывать ли поле в списке. Возможные значения:
- Y — да
- N — нет

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

Редактировать ли поле в списке. Возможные значения:
- Y — да
- N — нет

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

Участвует ли поле в поиске. Возможные значения:
- Y — да
- N — нет

SETTINGS object необязательный

Объект в формате {"field_1": "value_1", ... "field_N": "value_N"} для передачи дополнительных настроек пользовательских полей. Настройки описаны ниже

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

Подпись в форме редактирования. Можно передать строку или объект с подписями по языкам в формате {"ru": "...", "en": "..."}. При передаче строки значение будет выставлено для всех языков

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

Заголовок столбца в списке. Можно передать строку или объект с подписями по языкам в формате {"ru": "...", "en": "..."}. При передаче строки значение будет выставлено для всех языков

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

Заголовок фильтра в списке. Можно передать строку или объект с подписями по языкам в формате {"ru": "...", "en": "..."}. При передаче строки значение будет выставлено для всех языков

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

Сообщение об ошибке при невалидном вводе. Можно передать строку или объект с текстами по языкам в формате {"ru": "...", "en": "..."}. При передаче строки значение будет выставлено для всех языков

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

Текст подсказки к полю. Можно передать строку или объект с текстами по языкам в формате {"ru": "...", "en": "..."}. При передаче строки значение будет выставлено для всех языков

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

Название пользовательского поля по умолчанию.

Значение будет выставлено в поля LIST_FILTER_LABEL, LIST_COLUMN_LABEL, EDIT_FORM_LABEL, ERROR_MESSAGE, HELP_MESSAGE, если в них не передано значение

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
    "id": 42,
    "fields": {
        "SORT": 150,
        "LIST_FILTER_LABEL": "New Title",
        "LIST_COLUMN_LABEL": "New List Title"
    }
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/user.userfield.update

Ответ

HTTP-статус: 200

{
    "result": true,
    "time": {
        "start":1747311864.008399,
        "finish":1747311865.063292,
        "duration":1.0548930168151855,
        "processing":0.17107510566711426,
        "date_start":"2025-05-15T14:24:24+02:00",
        "date_finish":"2025-05-15T14:24:25+02:00",
        "operating":0
    }
}

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

result boolean

Cодержит true в случае успешного обновления пользовательского поля

time time

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

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

HTTP-статус: 400

{
    "error":"",
    "error_description":"Access denied."
}
Код Описание Значение
Пустая строка Access denied. Поле с таким id не существует или доступ запрещен
Пустая строка ID is not defined or invalid Не задан или введен неверный id

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

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