Эффективная интеграция и кастомизация функционала в Битрикс24 часто требует работы на уровне API. Сегодня мы подробно рассмотрим «Изменить существующее пользовательское поле сделок crm.deal.userfield.update». Вы узнаете экспертные методики работы с crm.deal.userfield.update и научитесь избегать типичных ошибок начинающих разработчиков.
Изменить существующее пользовательское поле сделок crm.deal.userfield.update
> Scope: crm
>
> Кто может выполнять метод: администратор CRM
Метод crm.deal.userfield.update обновляет существующее пользовательское поле сделок.
Параметры метода
Названиетип | Описание |
|---|---|
idinteger | Идентификатор пользовательского поля. Идентификатор можно получить с помощью методов crm.deal.userfield.add и crm.deal.userfield.list |
fieldsobject | Объект формата:— Список доступных полей описан ниже. Некорректное поле в В |
Параметр fields {#parameter-fields}
Параметртип | Описание | |
|---|---|---|
MANDATORYboolean | Является ли поле обязательным. Возможные значения: — Y — да— N — нет | |
SHOW_FILTERboolean | Показывать ли поле в фильтре. Возможные значения: — Y — да— N — нет | |
XML_IDstring | Внешний код | |
SETTINGSobject | Дополнительные параметры поля. Для каждого типа поля USER_TYPE_ID существует свой пул доступных настроек, они описаны ниже.Поле перезаписывает лишь переданные значения | |
LISTuf_enum_element[] | Список возможных значений для пользовательского поля типа enumeration, описание ниже | |
SORTinteger | Индекс сортировки. Обязательно больше нуля | |
SHOW_IN_LISTboolean | Показывать ли пользовательское поле в списке. Данный параметр ни на что не влияет в рамках Возможные значения: | |
EDIT_IN_LISTboolean | Разрешать ли редактирование пользователем. Возможные значения: — Y — да— N — нет Значение N поддерживают не все типы полей в рамках crm | |
IS_SEARCHABLEboolean | Участвуют ли значения поля в поиске. Данный параметр ни на что не влияет в рамках Возможные значения: | |
LIST_FILTER_LABELstring\ | lang_map | Подпись фильтра в списке. При передаче строки она устанавливается для каждого языка. Для языков, у которых явно не указано значение, будет записано Поле полностью перезаписывает предыдущее значение |
LIST_COLUMN_LABELstring\ | lang_map | Заголовок в списке. При передаче строки она устанавливается для каждого языка. Для языков, у которых явно не указано значение, будет записано Поле полностью перезаписывает предыдущее значение |
EDIT_FORM_LABELstring\ | lang_map | Подпись в форме редактирования. При передаче строки она устанавливается для каждого языка. Для языков, у которых явно не указано значение, будет записано Поле полностью перезаписывает предыдущее значение |
ERROR_MESSAGEstring\ | lang_map | Сообщение об ошибке |
HELP_MESSAGEstring\ | lang_map | Помощь |
Параметр SETTINGS {#settings}
У каждого типа пользовательских полей существует свой набор дополнительных настроек. Данный метод поддерживает лишь те, что описаны ниже.
- string
Названиетип | Описание |
|---|---|
DEFAULT_VALUEstring | Значение по умолчанию |
ROWSinteger | Количество строк в поле ввода. Обязательно больше 0 |
- integer
Названиетип | Описание |
|---|---|
DEFAULT_VALUEinteger | Значение по умолчанию |
- double
Названиетип | Описание |
|---|---|
DEFAULT_VALUEdouble | Значение по умолчанию |
PRECISIONinteger | Точность числа. Обязательно больше или равно 0 |
- boolean
Названиетип | Описание |
|---|---|
DEFAULT_VALUEinteger | Значение по умолчанию, где 1 — да, 0 — нет. Возможные значения: |
DISPLAYstring | Внешний вид. Возможные значения: — CHECKBOX — флажок— RADIO — радиокнопки— DROPDOWN — выпадающий список |
- date|datetime
Названиетип | Описание |
|---|---|
DEFAULT_VALUEobject | Значение по умолчанию. Объект формата: где: |
- enumeration
Названиетип | Описание |
|---|---|
DISPLAYstring | Внешний вид. Возможные значения: — LIST — список— UI — набираемый список— CHECKBOX — флажки— DIALOG — диалог выбора сущностей |
| LIST_HEIGHT | Высота списка. Обязательно больше 0. Доступен только при |
- iblock_section|iblock_element
Названиетип | Описание |
|---|---|
IBLOCK_TYPE_IDstring | Идентификатор типа инфоблока |
IBLOCK_IDstring | Идентификатор инфоблока |
DEFAULT_VALUEstring | Значение по умолчанию |
DISPLAYstring | Внешний вид. Возможные значения: — DIALOG — диалог— UI — набираемый список— LIST — список— CHECKBOX — флажки |
LIST_HEIGHTinteger | Высота списка. Обязательно больше 0 |
ACTIVE_FILTERboolean | Показывать ли элементы с включенным флагом активности. Возможные значения: — Y — да— N — нет |
- crm_status
Названиетип | Описание |
|---|---|
ENTITY_TYPEstring | Идентификатор типа справочника. Используйте |
- crm
Названиетип | Описание |
|---|---|
LEADboolean | Включена ли привязка к Лидам. Возможные значения: — Y — да— N — нет |
CONTACTboolean | Включена ли привязка к Контактам. Возможные значения: — Y — да— N — нет |
COMPANYboolean | Включена ли привязка к Компаниям. Возможные значения: — Y — да— N — нет |
DEALboolean | Включена ли привязка к Сделкам. Возможные значения: — Y — да— N — нет |
Параметр LIST {#uf_enum_element}
Названиетип | Описание |
|---|---|
VALUEstring | Значение элемента списка. Элементы списка с пустым или отсутствующим |
SORTinteger | Индекс сортировки. Обязательно больше или равно 0 |
DEFboolean | Является ли элемент списка значением по умолчанию. Возможные значения: — Y — да— N — нетДля множественного поля допустимо несколько |
XML_IDstring | Внешний код значения. Обязательно уникальный в рамках элементов списка пользовательского поля |
Примеры кода
Пример изменения пользовательского поля типа Строка
- cURL (Webhook)
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":536,"fields":{"MANDATORY":"N","SHOW_FILTER":"N","SETTINGS":{"DEFAULT_VALUE":"Привет, мир! Значение по умолчанию (изменено)","ROWS":10},"SORT":2000,"EDIT_IN_LIST":"N","LIST_FILTER_LABEL":"Привет, мир! Фильтр (изменено)","LIST_COLUMN_LABEL":{"en":"Hello, World! Column (changed)","ru":"Привет, мир! Колонка (изменено)","de":"Hallo, Welt! Spalte (geändert)"},"EDIT_FORM_LABEL":{"en":"Hello, World! Edit (changed)","ru":"Привет, мир! Редактировать (изменено)","de":"Hallo, Welt! Bearbeiten (geändert)"},"ERROR_MESSAGE":{"en":"Hello, World! Error (changed)","ru":"Привет, мир! Ошибка (изменено)","de":"Hallo, Welt! Fehler (geändert)"},"HELP_MESSAGE":{"en":"Hello, World! Help (changed)","ru":"Привет, мир! Помощь (изменено)","de":"Hallo, Welt! Hilfe (geändert)"}}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webbhook_here**/crm.deal.userfield.update- cURL (OAuth)
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":536,"fields":{"MANDATORY":"N","SHOW_FILTER":"N","SETTINGS":{"DEFAULT_VALUE":"Привет, мир! Значение по умолчанию (изменено)","ROWS":10},"SORT":2000,"EDIT_IN_LIST":"N","LIST_FILTER_LABEL":"Привет, мир! Фильтр (изменено)","LIST_COLUMN_LABEL":{"en":"Hello, World! Column (changed)","ru":"Привет, мир! Колонка (изменено)","de":"Hallo, Welt! Spalte (geändert)"},"EDIT_FORM_LABEL":{"en":"Hello, World! Edit (changed)","ru":"Привет, мир! Редактировать (изменено)","de":"Hallo, Welt! Bearbeiten (geändert)"},"ERROR_MESSAGE":{"en":"Hello, World! Error (changed)","ru":"Привет, мир! Ошибка (изменено)","de":"Hallo, Welt! Fehler (geändert)"},"HELP_MESSAGE":{"en":"Hello, World! Help (changed)","ru":"Привет, мир! Помощь (изменено)","de":"Hallo, Welt! Hilfe (geändert)"}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.deal.userfield.update- JS
BX24.callMethod(
'crm.deal.userfield.update',
{
id: 536,
fields: {
MANDATORY: "N",
SHOW_FILTER: "N",
SETTINGS: {
DEFAULT_VALUE: "Привет, мир! Значение по умолчанию (изменено)",
ROWS: 10,
},
SORT: 2000,
EDIT_IN_LIST: "N",
LIST_FILTER_LABEL: "Привет, мир! Фильтр (изменено)",
LIST_COLUMN_LABEL: {
"en": "Hello, World! Column (changed)",
"ru": "Привет, мир! Колонка (изменено)",
"de": "Hallo, Welt! Spalte (geändert)"
},
EDIT_FORM_LABEL: {
"en": "Hello, World! Edit (changed)",
"ru": "Привет, мир! Редактировать (изменено)",
"de": "Hallo, Welt! Bearbeiten (geändert)"
},
ERROR_MESSAGE: {
"en": "Hello, World! Error (changed)",
"ru": "Привет, мир! Ошибка (изменено)",
"de": "Hallo, Welt! Fehler (geändert)"
},
HELP_MESSAGE: {
"en": "Hello, World! Help (changed)",
"ru": "Привет, мир! Помощь (изменено)",
"de": "Hallo, Welt! Hilfe (geändert)"
},
},
},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data())
;
},
);- PHP
require_once('crest.php');
$result = CRest::call(
'crm.deal.userfield.update',
[
'id' => 536,
'fields' => [
'MANDATORY' => "N",
'SHOW_FILTER' => "N",
'SETTINGS' => [
'DEFAULT_VALUE' => "Привет, мир! Значение по умолчанию (изменено)",
'ROWS' => 10,
],
'SORT' => 2000,
'EDIT_IN_LIST' => "N",
'LIST_FILTER_LABEL' => "Привет, мир! Фильтр (изменено)",
'LIST_COLUMN_LABEL' => [
'en' => "Hello, World! Column (changed)",
'ru' => "Привет, мир! Колонка (изменено)",
'de' => "Hallo, Welt! Spalte (geändert)"
],
'EDIT_FORM_LABEL' => [
'en' => "Hello, World! Edit (changed)",
'ru' => "Привет, мир! Редактировать (изменено)",
'de' => "Hallo, Welt! Bearbeiten (geändert)"
],
'ERROR_MESSAGE' => [
'en' => "Hello, World! Error (changed)",
'ru' => "Привет, мир! Ошибка (изменено)",
'de' => "Hallo, Welt! Fehler (geändert)"
],
'HELP_MESSAGE' => [
'en' => "Hello, World! Help (changed)",
'ru' => "Привет, мир! Помощь (изменено)",
'de' => "Hallo, Welt! Hilfe (geändert)"
],
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';Обработка ответа
HTTP-статус: 200
{
"result": true,
"time": {
"start": 1753790234.592207,
"finish": 1753790234.762644,
"duration": 0.17043709754943848,
"processing": 0.11566615104675293,
"date_start": "2025-07-29T14:57:14+03:00",
"date_finish": "2025-07-29T14:57:14+03:00",
"operating_reset_at": 1753790834,
"operating": 0.11564803123474121
}
}Возвращаемые данные
Названиетип | Описание |
|---|---|
resultboolean | Корневой элемент ответа, содержит true в случае успеха |
timetime | Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "Access denied."
}Возможные коды ошибок
| Код | Описание | Значение |
|---|---|---|
400 | Parameter 'fields' must be array | Переданный fields не является объектом |
400 | ID is not defined or invalid | Переданный id меньше нуля или не передан вовсе |
403 | Access denied | Возникает в случаях, когда: — у пользователя нет административных прав — пользователь пытается изменить пользовательское поле, не привязанное к сделкам |
ERROR_NOT_FOUND | The entity with ID 'id' is not found | Пользовательского поля с переданным id не существует |
ERROR_CORE | Элемент списка со значением XML_ID='XML_ID' уже существует | Переданный XML_ID у элемента списка обязан быть уникальным в рамках элементов списка отдельно взятого пользовательского поля |
- [](./crm-deal-userfield-add)
- [](./crm-deal-userfield-get)
- [](./crm-deal-userfield-list)
- [](./crm-deal-userfield-delete)
💡 Экспертное мнение и рекомендации
Практические рекомендации:
- При написании кастомных компонентов для «Изменить существующее пользовательское поле сделок crm.deal.userfield.update» всегда разделяйте бизнес-логику и представление (шаблон).
- Используйте отладку SQL-запросов через конструкцию
$wpdb->last_queryили стандартный трекер Битрикса, чтобы контролировать нагрузку.
Похожая задача в бизнесе?
Помогу автоматизировать процессы и внедрить ИИ
Меня зовут Андрей Горошко. Я Full-stack разработчик и эксперт по 1С-Битрикс. Настраиваю CRM Битрикс24, разрабатываю защищенные API и создаю умных ИИ-агентов для автоматизации рутины.
или на почту: gorandvas@yandex.ru