Изменить пользовательское поле v 3.0 crm.<тип>.field.custom.update
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: пользователь с правом «Разрешить изменять настройки» в CRM
Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.
Метод crm.<тип>.field.custom.update изменяет настройки пользовательского поля и возвращает его описание. Тип объекта задает сегмент <тип> в имени метода.
Имя метода для типа объекта
|
Тип объекта |
Метод |
Поля |
|
Сделка |
|
|
|
Лид |
|
|
|
Контакт |
|
|
|
Компания |
|
|
|
Предложение |
|
|
|
Счет |
|
|
|
Смарт-процесс |
|
Для смарт-процесса в имя метода подставляется идентификатор его типа entityTypeId. Идентификаторы типов смарт-процессов возвращает метод crm.type.list в поле entityTypeId. Методы пользовательских полей есть у смарт-процесса при любых настройках типа. У моей компании этих методов нет: на crm.mycompany.field.custom.update Битрикс24 ответит ошибкой «Метод не найден».
Имя метода пишется в нижнем регистре: crm.smartinvoice.field.custom.update, а не crm.smartInvoice.field.custom.update. На имя в другом регистре метод отвечает ошибкой «Метод не найден».
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
Идентификатор поля или его имя, например Идентификаторы и имена полей возвращает метод crm.<тип>.field.custom.list |
|
|
fields* |
Объект с новыми настройками поля в формате |
Параметр fields
Передайте только те параметры, которые нужно изменить. Изменять можно:
xmlId,sort,isMandatory,showFilter,showInList,editInList,isSearchablesettings— настройки типа поля- подписи
editFormLabel,listColumnLabel,listFilterLabel,errorMessage,helpMessage
Значения и формат параметров — такие же, как в методе crm.<тип>.field.custom.add.
Имя name, тип userTypeId и признак множественности isMultiple после создания поля изменить нельзя. На isMultiple метод ответит ошибкой валидации.
Параметры name и userTypeId метод не меняет и ошибку на них не возвращает. Если передать их вместе с другими параметрами, метод изменит только другие параметры и ответит успешно. Если других параметров в fields нет, метод ответит ошибкой «At least one field must be specified.».
Метод заменяет настройки settings целиком: настройки, которые не переданы, возвращаются к значениям по умолчанию. Например, если у поля задан minLength = 3, а в settings передать только maxLength, minLength станет 0. Передавайте в settings все настройки, которые нужно сохранить. Текущие настройки возвращает метод crm.<тип>.field.custom.get.
Подпись строкой меняет текст только на языке Битрикс24 по умолчанию, подписи на других языках сохраняются. Объект с кодами языков меняет подписи на переданных языках.
Примеры кода
Как использовать примеры в документации
Вызов нового API отличается добавлением параметра /api/ в запросе:
https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/crm.smartprocess1038.field.custom.update
Примеры меняют подпись поля на двух языках, режим поиска в фильтре и максимальную длину значения у поля смарт-процесса с идентификатором типа 1038. Для другого типа объекта замените имя метода по таблице выше.
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":6008209,"fields":{"editFormLabel":{"ru":"Номер договора с клиентом","en":"Client contract number"},"showFilter":"S","settings":{"maxLength":40}}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.smartprocess1038.field.custom.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":6008209,"fields":{"editFormLabel":{"ru":"Номер договора с клиентом","en":"Client contract number"},"showFilter":"S","settings":{"maxLength":40}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/crm.smartprocess1038.field.custom.update
Методы CRM пока не входят в список методов REST 3.0, который знает $b24.actions.v3.call.make: такой вызов вернет ошибку SDK JSSDK_CORE_METHOD_NOT_SUPPORT_IN_API_V3. Вызывайте метод через HTTP-клиент REST 3.0 — $b24.getHttpClient(ApiVersion.v3).call.
import { ApiVersion, Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type CustomFieldUpdateResult = {
item: {
id: number
name: string
userTypeId: string
editFormLabel: string | null
}
}
try {
const response = await $b24.getHttpClient(ApiVersion.v3).call<CustomFieldUpdateResult>(
'crm.smartprocess1038.field.custom.update',
{
id: 6008209,
fields: {
editFormLabel: {
ru: 'Номер договора с клиентом',
en: 'Client contract number',
},
showFilter: 'S',
settings: {
maxLength: 40,
},
},
},
Text.getUuidRfc4122()
)
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Field updated:', result.item.id, result.item.editFormLabel)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
Методы CRM пока не входят в список методов REST 3.0, который знает $b24.actions.v3.call.make. Вызывайте метод через HTTP-клиент REST 3.0 — $b24.getHttpClient(B24Js.ApiVersion.v3).call.
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function updateCustomField() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.getHttpClient(B24Js.ApiVersion.v3).call(
'crm.smartprocess1038.field.custom.update',
{
id: 6008209,
fields: {
editFormLabel: {
ru: 'Номер договора с клиентом',
en: 'Client contract number',
},
showFilter: 'S',
settings: {
maxLength: 40,
},
},
},
B24Js.Text.getUuidRfc4122()
)
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Field updated:', result.item.id, result.item.editFormLabel)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', updateCustomField)
</script>
У методов CRM нет готовых оберток в b24pysdk, и SDK отправляет в REST 3.0 только методы из списка Config().api_v3_methods. Добавьте метод в этот список и вызовите его через bitrix_token.call_method с prefer_version=3.
from b24pysdk import Config
from b24pysdk.errors import BitrixSDKException
from b24pysdk.errors.v3 import BitrixAPIError
method = "crm.smartprocess1038.field.custom.update"
Config().configure(api_v3_methods=Config().api_v3_methods | {method})
try:
response = bitrix_token.call_method(
api_method=method,
params={
"id": 6008209,
"fields": {
"editFormLabel": {
"ru": "Номер договора с клиентом",
"en": "Client contract number",
},
"showFilter": "S",
"settings": {
"maxLength": 40,
},
},
},
prefer_version=3,
)
result = response["result"]
print(result["item"]["id"], result["item"]["editFormLabel"])
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"code: {error.code}",
f"message: {error.error.message}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.
try {
$response = $b24Service
->core
->call(
'crm.smartprocess1038.field.custom.update',
[
'id' => 6008209,
'fields' => [
'editFormLabel' => [
'ru' => 'Номер договора с клиентом',
'en' => 'Client contract number',
],
'showFilter' => 'S',
'settings' => [
'maxLength' => 40,
],
],
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.
BX24.callMethod(
'crm.smartprocess1038.field.custom.update',
{
id: 6008209,
fields: {
editFormLabel: {
ru: 'Номер договора с клиентом',
en: 'Client contract number',
},
showFilter: 'S',
settings: {
maxLength: 40,
},
},
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.
require_once('crest.php');
$result = CRest::call(
'crm.smartprocess1038.field.custom.update',
[
'id' => 6008209,
'fields' => [
'editFormLabel' => [
'ru' => 'Номер договора с клиентом',
'en' => 'Client contract number',
],
'showFilter' => 'S',
'settings' => [
'maxLength' => 40,
],
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.smartprocess1038.field.custom.update", b24.Params{
"id": 6008209,
"fields": b24.Params{
"editFormLabel": b24.Params{
"ru": "Номер договора с клиентом",
"en": "Client contract number",
},
"showFilter": "S",
"settings": b24.Params{
"maxLength": 40,
},
},
})
if err != nil {
return fmt.Errorf("crm.smartprocess1038.field.custom.update: %w", err)
}
var out struct {
Item struct {
ID int `json:"id"`
Name string `json:"name"`
} `json:"item"`
}
if err := json.Unmarshal(res.Result, &out); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(out.Item.ID, out.Item.Name)
Обработка ответа
HTTP-статус: 200
{
"result": {
"item": {
"id": 6008209,
"entityId": "CRM_19",
"name": "UF_CRM_CONTRACT_NUMBER",
"userTypeId": "string",
"xmlId": null,
"sort": 100,
"isMultiple": false,
"isMandatory": false,
"showFilter": "S",
"showInList": true,
"editInList": true,
"isSearchable": false,
"settings": {
"size": 20,
"rows": 1,
"regexp": "",
"minLength": 0,
"maxLength": 40,
"defaultValue": ""
},
"editFormLabel": "Номер договора с клиентом",
"listColumnLabel": null,
"listFilterLabel": null,
"errorMessage": null,
"helpMessage": null
}
},
"time": {
"start": 1793716015,
"finish": 1793716015.706175,
"duration": 0.7061750888824463,
"processing": 0,
"date_start": "2026-11-03T17:26:55+03:00",
"date_finish": "2026-11-03T17:26:55+03:00",
"operating_reset_at": 1793716560,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Объект с данными ответа |
|
result.item |
Описание поля после изменения: параметры поля, а также |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION",
"message": "Ошибка при валидации объекта",
"validation": [
{
"message": "Поле \"isMultiple\" не доступно к заполнению",
"field": "isMultiple"
}
]
}
}
|
Название |
Описание |
|
error.code |
Строковый код ошибки. Используйте для идентификации типа исключения |
|
error.message |
Текстовое описание ошибки |
|
error.validation |
Массив c деталями ошибки. Присутствует только в ошибках валидации данных |
|
error.validation[].field |
Название поля, в котором возникла ошибка валидации |
|
error.validation[].message |
Описание ошибки, связанной с указанным полем |
Возможные коды ошибок
Ошибки валидации запроса
Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Не заполнено значение хотя бы одного обязательного поля: id, filter |
Передайте |
|
|
Обязательное поле |
Передайте объект |
|
|
At least one field must be specified. |
Передайте в |
|
|
В поле |
Передайте числовой идентификатор поля или имя, которое начинается с |
|
|
В поле |
Передайте значение того типа, который указан в описании параметра. Логические параметры принимают только |
|
|
В поле |
Передайте |
Ошибки валидации объекта
Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Поле "isMultiple" не доступно к заполнению |
Уберите |
|
|
Поле "id" не доступно к заполнению |
Уберите |
|
|
Поле "entityId" не доступно к заполнению |
Уберите |
|
|
Значение поля не содержится в списке допустимых значений: N, I, E, S |
Передайте одно из значений |
Поле не найдено
Код ошибки: BITRIX_REST_V3_REALISATION_EXCEPTION_FIELDNOTFOUNDEXCEPTION, HTTP-статус 404
|
Поле |
Описание ошибки |
Как исправить |
|
|
Поле |
Проверьте идентификатор или имя поля методом crm.<тип>.field.custom.list. Ошибку вызывает и поле другого типа объекта, и поле, которое пользователю недоступно |
Ошибка фильтра
Код ошибки: BITRIX_REST_V3_EXCEPTION_INVALIDFILTEREXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Не удается распознать выражение фильтра |
Уберите |
Ошибка неизвестного поля
Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Неизвестное поле |
Проверьте имя параметра по таблице параметра fields. Ошибку с именем поля |
Ошибка доступа
Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION, HTTP-статус 403
|
Поле |
Описание ошибки |
Как исправить |
|
|
Доступ запрещен |
Вызовите метод от имени пользователя с правом «Разрешить изменять настройки» в CRM |
Метод не найден
Код ошибки: BITRIX_REST_V3_EXCEPTION_METHODNOTFOUNDEXCEPTION, HTTP-статус 404
|
Поле |
Описание ошибки |
Как исправить |
|
|
Метод |
Проверьте имя метода: оно пишется в нижнем регистре, например |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Поля CRM в REST 3.0: обзор методов
- Создать пользовательское поле v 3.0 crm.<тип>.field.custom.add
- Получить пользовательское поле v 3.0 crm.<тип>.field.custom.get
- Получить список пользовательских полей v 3.0 crm.<тип>.field.custom.list
- Удалить пользовательское поле v 3.0 crm.<тип>.field.custom.delete