Изменить существующее пользовательское поле предложений crm.quote.userfield.update
Scope:
crmКто может выполнять метод: администратор CRM
Метод crm.quote.userfield.update обновляет существующее пользовательское поле предложений.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
id* |
Идентификатор пользовательского поля. Идентификатор можно получить с помощью методов crm.quote.userfield.add и crm.quote.userfield.list |
|
fields* |
Объект формата:
Список доступных полей описан ниже. Некорректное поле в В |
Параметр fields
Обязательные параметры отмечены *
|
Параметр |
Описание |
|
MANDATORY |
Является ли поле обязательным. Возможные значения:
|
|
SHOW_FILTER |
Показывать ли поле в фильтре. Возможные значения:
|
|
XML_ID |
Внешний код |
|
SETTINGS |
Дополнительные параметры поля. Для каждого типа поля Поле перезаписывает лишь переданные значения |
|
LIST |
Список возможных значений для пользовательского поля типа |
|
SORT |
Индекс сортировки. Обязательно больше нуля |
|
SHOW_IN_LIST |
Показывать ли пользовательское поле в списке. Данный параметр ни на что не влияет в рамках Возможные значения:
|
|
EDIT_IN_LIST |
Разрешать ли редактирование пользователем. Возможные значения:
|
|
IS_SEARCHABLE |
Участвуют ли значения поля в поиске. Данный параметр ни на что не влияет в рамках Возможные значения:
|
|
Подпись фильтра в списке. При передаче строки она устанавливается для каждого языка. Для языков, у которых явно не указано значение, будет записано Поле полностью перезаписывает предыдущее значение |
|
|
Заголовок в списке. При передаче строки она устанавливается для каждого языка. Для языков, у которых явно не указано значение, будет записано Поле полностью перезаписывает предыдущее значение |
|
|
Подпись в форме редактирования. При передаче строки она устанавливается для каждого языка. Для языков, у которых явно не указано значение, будет записано Поле полностью перезаписывает предыдущее значение |
|
|
Сообщение об ошибке |
|
|
Помощь |
Параметр SETTINGS
У каждого типа пользовательских полей существует свой набор дополнительных настроек. Данный метод поддерживает лишь те, что описаны ниже.
|
Название |
Описание |
|
DEFAULT_VALUE |
Значение по умолчанию |
|
ROWS |
Количество строк в поле ввода. Обязательно больше 0 |
|
Название |
Описание |
|
DEFAULT_VALUE |
Значение по умолчанию |
|
Название |
Описание |
|
DEFAULT_VALUE |
Значение по умолчанию |
|
PRECISION |
Точность числа. Обязательно больше или равно 0 |
|
Название |
Описание |
|
DEFAULT_VALUE |
Значение по умолчанию, где Возможные значения:
|
|
DISPLAY |
Внешний вид. Возможные значения:
|
|
Название |
Описание |
|
DEFAULT_VALUE |
Значение по умолчанию.
где:
|
|
Название |
Описание |
|
DISPLAY |
Внешний вид. Возможные значения:
|
|
LIST_HEIGHT |
Высота списка. Обязательно больше 0. Доступен только при |
|
Название |
Описание |
|
IBLOCK_TYPE_ID |
Идентификатор типа инфоблока |
|
IBLOCK_ID |
Идентификатор инфоблока |
|
DEFAULT_VALUE |
Значение по умолчанию |
|
DISPLAY |
Внешний вид. Возможные значения:
|
|
LIST_HEIGHT |
Высота списка. Обязательно больше 0 |
|
ACTIVE_FILTER |
Показывать ли элементы с включенным флагом активности. Возможные значения:
|
|
Название |
Описание |
|
ENTITY_TYPE |
Идентификатор типа справочника. Используйте |
|
Название |
Описание |
|
LEAD |
Включена ли привязка к Лидам. Возможные значения:
|
|
CONTACT |
Включена ли привязка к Контактам. Возможные значения:
|
|
COMPANY |
Включена ли привязка к Компаниям. Возможные значения:
|
|
DEAL |
Включена ли привязка к Сделкам. Возможные значения:
|
Параметр LIST
|
Название |
Описание |
|
VALUE |
Значение элемента списка. Элементы списка с пустым или отсутствующим |
|
SORT |
Индекс сортировки. Обязательно больше или равно 0 |
|
DEF |
Является ли элемент списка значением по умолчанию. Возможные значения:
Для множественного поля допустимо несколько |
|
XML_ID |
Внешний код значения. Обязательно уникальный в рамках элементов списка пользовательского поля |
Примеры кода
Как использовать примеры в документации
Пример изменения пользовательского поля типа Строка
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_webhook_here**/crm.quote.userfield.update
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.quote.userfield.update
try
{
const response = await $b24.callMethod(
'crm.quote.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)',
},
},
}
);
console.info(response.getData().result);
}
catch (error)
{
console.error(error);
}
try {
$result = $serviceBuilder
->getCRMScope()
->quoteUserfield()
->update(
536,
[
'MANDATORY' => 'N',
'SHOW_FILTER' => 'N',
'SETTINGS' => [
'DEFAULT_VALUE' => 'Привет, мир! Значение по умолчанию (изменено)',
'ROWS' => 10,
],
'SORT' => 2000,
'EDIT_IN_LIST' => 'N',
'LIST_FILTER_LABEL' => 'Привет, мир! Фильтр (изменено)',
]
);
print($result->isSuccess() ? 'Updated' : 'Failed');
} catch (Throwable $e) {
print('Error: ' . $e->getMessage());
}
BX24.callMethod(
'crm.quote.userfield.update',
{
id: 536,
fields: {
MANDATORY: 'N',
SHOW_FILTER: 'N',
SETTINGS: {
DEFAULT_VALUE: 'Привет, мир! Значение по умолчанию (изменено)',
ROWS: 10,
},
SORT: 2000,
EDIT_IN_LIST: 'N',
LIST_FILTER_LABEL: 'Привет, мир! Фильтр (изменено)',
},
},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.quote.userfield.update',
[
'id' => 536,
'fields' => [
'MANDATORY' => 'N',
'SHOW_FILTER' => 'N',
'SETTINGS' => [
'DEFAULT_VALUE' => 'Привет, мир! Значение по умолчанию (изменено)',
'ROWS' => 10,
],
'SORT' => 2000,
'EDIT_IN_LIST' => 'N',
'LIST_FILTER_LABEL' => 'Привет, мир! Фильтр (изменено)',
]
]
);
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
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа, содержит |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "Access denied."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
Parameter 'fields' must be array |
Переданный |
|
|
ID is not defined or invalid |
Переданный |
|
|
Access denied |
Возникает в случаях, когда:
|
|
|
The entity with ID 'id' is not found |
Пользовательского поля с переданным |
|
|
Элемент списка со значением XML_ID='XML_ID' уже существует |
Переданный |
Продолжите изучение
- Создать пользовательское поле для предложений crm.quote.userfield.add
- Получить пользовательское поле предложений по id crm.quote.userfield.get
- Получить список пользовательских полей предложений crm.quote.userfield.list
- Удалить пользовательское поле предложений crm.quote.userfield.delete