Блог Горошко Андрея Bitrix24 Обновить пользовательское поле user.userfield.update

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

Каждый PHP-разработчик, работающий с экосистемой Bitrix Framework, должен глубоко понимать работу её ключевых компонентов. В этой статье мы проведем подробный аудит темы «Обновить пользовательское поле user.userfield.update», проанализируем лучшие практики и покажем, как правильно использовать user.userfield.update в реальных задачах.

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

> Scope: user.userfield
>
> Кто может выполнять метод: администратор

Метод 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, если в них не передано значение

Параметр SETTINGS {#settings}

У каждого типа пользовательских полей существует свой набор дополнительных настроек.

  • string
Название
тип
Описание
DEFAULT_VALUE
string
Значение по умолчанию.

По умолчанию ''

ROWS
integer
Количество строк в поле ввода. Обязательно больше 0.

По умолчанию 1

  • integer
Название
тип
Описание
DEFAULT_VALUE
integer
Значение по умолчанию
  • double
Название
тип
Описание
DEFAULT_VALUE
double
Значение по умолчанию
PRECISION
integer
Точность числа. Обязательно больше или равно 0.

По умолчанию 2

  • boolean
Название
тип
Описание
DEFAULT_VALUE
integer
Значение по умолчанию, где 1 — да, 0 — нет.

Возможные значения:
— >= 1 -> 1
— <= 0 -> 0

По умолчанию 0

DISPLAY
string
Внешний вид. Возможные значения:
— CHECKBOX — флажок
— RADIO — радиокнопки
— DROPDOWN — выпадающий список

По умолчанию CHECKBOX

  • datetime
Название
тип
Описание
DEFAULT_VALUE
object
Значение по умолчанию.

Объект формата:

    {
        VALUE: datetime|date,
        TYPE: 'NONE'|'NOW'|'FIXED',
    }

где:
— VALUE — значение по умолчанию типа datetime или date
— TYPE — тип значения по умолчанию:
— NONE — не выставлять значение по умолчанию
— NOW — использовать текущее время/дату
— FIXED — использовать время/дату из VALUE

Значение по умолчанию:

    {
        VALUE: '',
        TYPE: 'NONE',
    }
  • enumeration
Название
тип
Описание
DISPLAY
string
Внешний вид. Возможные значения:
— LIST — список
— UI — набираемый список
— CHECKBOX — флажки
— DIALOG — диалог выбора сущностей

По умолчанию LIST

LIST_HEIGHTВысота списка. Обязательно больше 0.

Доступен только при DISPLAY = LIST или DISPLAY = UI.

По умолчанию 1

  • iblock_section|iblock_element
Название
тип
Описание
IBLOCK_TYPE_ID
string
Идентификатор типа инфоблока.

По умолчанию ''

IBLOCK_ID
string
Идентификатор инфоблока.

По умолчанию 0

DEFAULT_VALUE
string
Значение по умолчанию.

По умолчанию ''

DISPLAY
string
Внешний вид. Возможные значения:
— DIALOG — диалог
— UI — набираемый список
— LIST — список
— CHECKBOX — флажки

По умолчанию LIST

LIST_HEIGHT
integer
Высота списка. Обязательно больше 0.

По умолчанию 1

ACTIVE_FILTER
boolean
Показывать ли элементы с включенным флагом активности. Возможные значения:
— Y — да
— N — нет

По умолчанию N

  • crm_status
Название
тип
Описание
ENTITY_TYPE
string
Идентификатор типа справочника.

Используйте crm.status.entity.types, чтобы узнать возможные значения.

По умолчанию ''

  • crm

Если не передать ни одну из следующих опций, то по умолчанию будет включена привязка к лидам (LEAD = Y).

Название
тип
Описание
LEAD
boolean
Включена ли привязка к Лидам. Возможные значения:
— Y — да
— N — нет

По умолчанию N

CONTACT
boolean
Включена ли привязка к Контактам. Возможные значения:
— Y — да
— N — нет

По умолчанию N

COMPANY
boolean
Включена ли привязка к Компаниям. Возможные значения:
— Y — да
— N — нет

По умолчанию N

DEAL
boolean
Включена ли привязка к Сделкам. Возможные значения:
— Y — да
— N — нет

По умолчанию N

Примеры кода

  • cURL (Webhook)
    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_webbhook_here**/user.userfield.update
  • cURL (OAuth)
    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"
        },
        "auth": "**put_access_token_here**"
    }' \
    https://**put_your_bitrix24_address**/rest/user.userfield.update
  • JS
    try
    {
        const response = await $b24.callMethod(
            'user.userfield.update',
            {
                id: 42,
                fields: {
                    SORT: 150,
                    LIST_FILTER_LABEL: 'New Title',
                    LIST_COLUMN_LABEL: 'New List Title',
                }
            }
        );

        const result = response.getData().result;
        console.log('Updated element with ID:', result);
        processResult(result);
    }
    catch( error )
    {
        console.error('Error:', error);
    }
  • PHP
    try {
        $response = $b24Service
            ->core
            ->call(
                'user.userfield.update',
                [
                    'id' => 42,
                    'fields' => [
                        'SORT' => 150,
                        'LIST_FILTER_LABEL' => 'New Title',
                        'LIST_COLUMN_LABEL' => 'New List Title',
                    ]
                ]
            );

        $result = $response
            ->getResponseData()
            ->getResult();

        echo 'Success: ' . print_r($result, true);
        processData($result);

    } catch (Throwable $e) {
        error_log($e->getMessage());
        echo 'Error updating user field: ' . $e->getMessage();
    }
  • BX24.js
    BX24.callMethod(
        'user.userfield.update', 
        {
            id: 42,
            fields: {
                SORT: 150,
                LIST_FILTER_LABEL: 'New Title',
                LIST_COLUMN_LABEL: 'New List Title',
            },
        },
        function(result) {
            if(result.error())
                console.error(result.error());
            else
                console.log(result.data());
        }
    );
  • PHP CRest
    require_once('crest.php');

    $result = CRest::call(
        'user.userfield.update',
        [
            'id' => 42,
            'fields' => [
                'SORT' => 150,
                'LIST_FILTER_LABEL' => 'New Title',
                'LIST_COLUMN_LABEL' => 'New List Title',
            ]
        ]
    );

    echo '<PRE>';
    print_r($result);
    echo '</PRE>';

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

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
  • [](./user-userfield-add)
  • [](./user-userfield-list)
  • [](./user-userfield-delete)

💡 Экспертное мнение и рекомендации

Ключевые выводы по теме «Обновить пользовательское поле user.userfield.update»:

Использование современных стандартов D7 при работе с user.userfield.update позволяет писать чистый, масштабируемый и безопасный код. Не забывайте обрабатывать исключения (try/catch) и проверять права доступа текущего пользователя перед выполнением критических операций.

Похожая задача в бизнесе?

Помогу автоматизировать процессы и внедрить ИИ

Меня зовут Андрей Горошко. Я Full-stack разработчик и эксперт по 1С-Битрикс. Настраиваю CRM Битрикс24, разрабатываю защищенные API и создаю умных ИИ-агентов для автоматизации рутины.

Related Post

Получить параметры карточки crm.lead.details.configuration.getПолучить параметры карточки crm.lead.details.configuration.get

Оптимизация производительности и безопасности — залог успешного проекта на 1С-Битрикс. Данный материал посвящен практическому применению «Получить параметры карточки crm.lead.details.configuration.get». Мы подготовили подробный разбор принципов работы и развернутые примеры интеграции. Получить

Приостановить текущий рабочий день timeman.pauseПриостановить текущий рабочий день timeman.pause

Каждый PHP-разработчик, работающий с экосистемой Bitrix Framework, должен глубоко понимать работу её ключевых компонентов. В этой статье мы проведем подробный аудит темы «Приостановить текущий рабочий день timeman.pause», проанализируем лучшие практики

Открепить все диалоги от оператора imopenlines.session.mode.unpinAllОткрепить все диалоги от оператора imopenlines.session.mode.unpinAll

Каждый PHP-разработчик, работающий с экосистемой Bitrix Framework, должен глубоко понимать работу её ключевых компонентов. В этой статье мы проведем подробный аудит темы «Открепить все диалоги от оператора imopenlines.session.mode.unpinAll», проанализируем лучшие