crm.requisite.userfield.update
Изменить пользовательское поле реквизита
Описание
Метод изменяет существующее пользовательское поле реквизита.
Параметры
id
integer
обязательный
Идентификатор пользовательского поля. Можно получить с помощью метода crm.requisite.userfield.list
fields
object
обязательный
Набор полей — объект вида {"поле": "значение"[, ...]}, значения которых нужно изменить
Параметр fields
XML_ID
string
необязательный
Внешний ключ. Используется для операций обмена. Идентификатор объекта внешней информационной базы.
Назначение поля может меняться конечным разработчиком
SORT
integer
необязательный
Сортировка
MULTIPLE
char
необязательный
Признак множественности. Возможные значения:
- Y — да
- N — нет
MANDATORY
char
необязательный
Признак обязательности. Возможные значения:
- Y — да
- N — нет
SHOW_FILTER
char
необязательный
Показывать ли в фильтре списка. Возможные значения:
- N — не показывать
- I — точное совпадение
- E — маска
- S — подстрока
SHOW_IN_LIST
char
необязательный
Показывать ли в списке. Возможные значения:
- Y — да
- N — нет
EDIT_IN_LIST
char
необязательный
Разрешать ли редактирование пользователем. Возможные значения:
- Y — да
- N — нет
IS_SEARCHABLE
char
необязательный
Участвуют ли значения поля в поиске. Возможные значения:
- Y — да
- N — нет
EDIT_FORM_LABEL
string
необязательный
Подпись в форме редактирования
LIST_COLUMN_LABEL
string
необязательный
Заголовок в списке
LIST_FILTER_LABEL
string
необязательный
Подпись фильтра в списке
ERROR_MESSAGE
string
необязательный
Сообщение об ошибке
HELP_MESSAGE
string
необязательный
Помощь
LIST
uf_enum_element
необязательный
Элементы списка. Для получения подробной информации смотрите раздел crm.userfield.enumeration.fields
SETTINGS
object
необязательный
Дополнительные настройки (зависят от типа). Для получения подробной информации смотрите раздел crm.userfield.settings.fields
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":235,"fields":{"EDIT_FORM_LABEL":"Категория","LIST_COLUMN_LABEL":"Категория","LIST_FILTER_LABEL":"Категория"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.userfield.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":235,"fields":{"EDIT_FORM_LABEL":"Категория","LIST_COLUMN_LABEL":"Категория","LIST_FILTER_LABEL":"Категория"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.requisite.userfield.update
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
try {
const response = await $b24.actions.v2.call.make<boolean>({
method: 'crm.requisite.userfield.update',
params: {
id: 235,
fields: {
EDIT_FORM_LABEL: 'Category',
LIST_COLUMN_LABEL: 'Category',
LIST_FILTER_LABEL: 'Category',
},
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('User field updated:', result)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function updateRequisiteUserField() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.requisite.userfield.update',
params: {
id: 235,
fields: {
EDIT_FORM_LABEL: 'Category',
LIST_COLUMN_LABEL: 'Category',
LIST_FILTER_LABEL: 'Category',
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('User field updated:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', updateRequisiteUserField)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.requisite.userfield.update(
bitrix_id=235,
fields={
"EDIT_FORM_LABEL": "Категория",
"LIST_COLUMN_LABEL": "Категория",
"LIST_FILTER_LABEL": "Категория",
},
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
$title = "Категория";
try {
$response = $b24Service
->core
->call(
'crm.requisite.userfield.update',
[
'id' => 235,
'fields' => [
'EDIT_FORM_LABEL' => $title,
'LIST_COLUMN_LABEL' => $title,
'LIST_FILTER_LABEL' => $title
]
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error updating user field: ' . $e->getMessage();
}
const title = "Категория";
BX24.callMethod(
"crm.requisite.userfield.update",
{
id: 235,
fields:
{
"EDIT_FORM_LABEL": title,
"LIST_COLUMN_LABEL": title,
"LIST_FILTER_LABEL": title
}
},
function(result)
{
if(result.error())
console.error(result.error());
else
{
console.info(result.data());
}
}
);
require_once('crest.php');
$title = "Категория";
$result = CRest::call(
'crm.requisite.userfield.update',
[
'id' => 235,
'fields' =>
[
'EDIT_FORM_LABEL' => $title,
'LIST_COLUMN_LABEL' => $title,
'LIST_FILTER_LABEL' => $title
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.requisite.userfield.update", b24.Params{
"id": 235,
"fields": b24.Params{
"EDIT_FORM_LABEL": "Категория",
"LIST_COLUMN_LABEL": "Категория",
"LIST_FILTER_LABEL": "Категория",
},
})
if err != nil {
return fmt.Errorf("crm.requisite.userfield.update: %w", err)
}
var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)
Ответ
HTTP-статус: 200
{
"result": true,
"time": {
"start": 1717769551.504986,
"finish": 1717769551.817433,
"duration": 0.31244707107543945,
"processing": 0.04784202575683594,
"date_start": "2024-06-07T16:12:31+02:00",
"date_finish": "2024-06-07T16:12:31+02:00",
"operating": 0
}
}
Возвращаемые данные
result
boolean
Результат изменения пользовательского поля реквизита:
- true — изменено
- false — не изменено
time
time
Информация о времени выполнения запроса
Обработка ошибок
{
"error": "",
"error_description": "The entity with ID '235' is not found."
}
| Код | Описание | Значение |
|---|---|---|
Пустая строка |
Operation is not allowed. Entity ID is not defined |
Пользовательское поле с указанным идентификатором не найдено |
Пустая строка |
The entity with ID '235' is not found |
Пользовательское поле с указанным идентификатором не найдено |
Пустая строка |
ID is not defined or invalid |
Идентификатор пользовательского поля не указан или имеет недопустимое значение |
Пустая строка |
Access denied |
Недостаточно прав доступа для изменения пользовательского поля |
ERROR_CORE |
Fail to update user field |
Не удалось изменить пользовательское поле |
ERROR_CORE |
Fail to save enumeration field values |
Не удалось сохранить значения пользовательского поля списочного типа (например, когда произошло дублирование внешнего ключа одного из значений) |

