Создать пользовательское поле v 3.0 crm.<тип>.field.custom.add

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: crm

Кто может выполнять метод: пользователь с правом «Разрешить изменять настройки» в CRM

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.

Метод crm.<тип>.field.custom.add создает пользовательское поле у типа объекта CRM и возвращает описание созданного поля. Тип объекта задает сегмент <тип> в имени метода.

Имя метода для типа объекта

Тип объекта

Метод

Поля

Сделка

crm.deal.field.custom.add

Поля сделки

Лид

crm.lead.field.custom.add

Поля лида

Контакт

crm.contact.field.custom.add

Поля контакта

Компания

crm.company.field.custom.add

Поля компании

Предложение

crm.quote.field.custom.add

Поля предложения

Счет

crm.smartinvoice.field.custom.add

Поля счета

Смарт-процесс

crm.smartprocess<entityTypeId>.field.custom.add, например crm.smartprocess1038.field.custom.add

Поля смарт-процесса

Для смарт-процесса в имя метода подставляется идентификатор его типа entityTypeId. Идентификаторы типов смарт-процессов возвращает метод crm.type.list в поле entityTypeId. Методы пользовательских полей есть у смарт-процесса при любых настройках типа. У моей компании этих методов нет: на crm.mycompany.field.custom.add Битрикс24 ответит ошибкой «Метод не найден».

Имя метода пишется в нижнем регистре: crm.smartinvoice.field.custom.add, а не crm.smartInvoice.field.custom.add. На имя в другом регистре метод отвечает ошибкой «Метод не найден».

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

fields*
object

Объект с настройками нового поля в формате {"параметр": "значение"}. Обязательные поля — name и userTypeId. Описание параметра

Параметр fields

Обязательные параметры отмечены *

Название
тип

Описание

name*
string

Имя поля. По этому имени значение поля передают в fields методов элементов, например crm.<тип>.add. Правила имени.

После создания имя изменить нельзя

userTypeId*
string

Тип поля. Возможные значения.

После создания тип изменить нельзя

xmlId
string

Внешний код поля, например идентификатор поля во внешней системе

sort
integer

Порядок сортировки поля в списке полей.

По умолчанию: 100

isMultiple
boolean

Признак множественного поля.

Возможные значения:

  • true — поле хранит несколько значений, значение поля у элемента передавайте массивом
  • false — поле хранит одно значение

По умолчанию: false

После создания признак изменить нельзя

isMandatory
boolean

Признак обязательного поля.

Возможные значения:

  • true — поле обязательно для заполнения
  • false — поле необязательно

По умолчанию: false

showFilter
string

Показывать ли поле в фильтре списка элементов и как искать по нему.

Возможные значения:

  • N — не показывать в фильтре
  • I — показывать, искать по точному совпадению
  • E — показывать, искать по маске
  • S — показывать, искать по подстроке

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

showInList
boolean

Показывать ли поле в списке элементов.

Возможные значения:

  • true — показывать
  • false — не показывать

По умолчанию: true

editInList
boolean

Разрешено ли менять значение поля в списке элементов.

Возможные значения:

  • true — разрешено
  • false — запрещено

По умолчанию: true

isSearchable
boolean

Участвуют ли значения поля в поиске.

Возможные значения:

  • true — участвуют
  • false — не участвуют

По умолчанию: false

settings
object

Настройки, которые зависят от типа поля, например значение по умолчанию или инфоблок для привязки. Описание параметра

editFormLabel
string | object

Название поля в карточке элемента. Как передать подписи

listColumnLabel
string | object

Заголовок колонки поля в списке элементов

listFilterLabel
string | object

Подпись поля в фильтре

errorMessage
string | object

Текст ошибки, которую видит пользователь при неверном значении

helpMessage
string | object

Текст подсказки к полю

Имена параметров пишутся в camelCase: userTypeId, isMultiple. Поля id и entityId метод не принимает: идентификатор поля Битрикс24 назначает сам, а тип объекта задает имя метода.

Правила имени

  • имя начинается с UF_, например UF_CRM_CONTRACT_NUMBER
  • в имени только заглавные латинские буквы, цифры и _
  • длина — не больше 50 символов
  • имя уникально в пределах типа объекта

Занятые имена возвращает метод crm.<тип>.field.custom.list.

Типы поля

  • string — строка
  • rich_text — форматированный текст
  • integer — целое число
  • double — дробное число
  • boolean — да или нет
  • date — дата
  • datetime — дата и время
  • money — деньги
  • url — ссылка
  • address — адрес
  • employee — привязка к сотруднику
  • crm — привязка к элементам CRM
  • crm_status — привязка к справочнику CRM
  • iblock_section — привязка к разделам инфоблока
  • iblock_element — привязка к элементам инфоблока

Поля типов «Список» enumeration и «Файл» file метод не создает и отвечает ошибкой валидации. Значениями уже существующего поля-списка управляют методы crm.<тип>.field.custom.enum.*.

Подписи поля

Подписи editFormLabel, listColumnLabel, listFilterLabel, errorMessage и helpMessage передаются двумя способами:

  • строкой — подпись сохраняется на языке Битрикс24 по умолчанию
  • объектом с кодами языков — подпись сохраняется на каждом из переданных языков: {"ru": "Номер договора", "en": "Contract number"}

В ответе метод возвращает подпись строкой на языке Битрикс24 по умолчанию. Если подпись на этом языке не задана, метод вернет null.

Параметр settings

Ключи settings пишутся в camelCase: iblockId, defaultValue, maxLength. Это правило касается только ключей первого уровня: ключи вложенных объектов Битрикс24 не переименовывает. Например, у поля datetime значение defaultValue приходит как {"TYPE": "NONE", "VALUE": ""}.

Набор ключей у каждого типа поля свой. Его возвращает метод crm.userfield.settings.fields с ключами в верхнем регистре: ключу IBLOCK_ID соответствует iblockId.

Логические настройки передаются как true или false. Настройки, которые не переданы, Битрикс24 заполняет значениями по умолчанию и возвращает их в ответе.

Для полей iblock_section и iblock_element настройка iblockId обязательна: без нее метод вернет ошибку «Выберите инфоблок, с которым нужно связать поле».

Примеры кода

Как использовать примеры в документации

Вызов нового API отличается добавлением параметра /api/ в запросе:

https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/crm.smartprocess1038.field.custom.add

Примеры создают строковое поле «Номер договора» у смарт-процесса с идентификатором типа 1038. Для другого типа объекта замените имя метода по таблице выше.

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"name":"UF_CRM_CONTRACT_NUMBER","userTypeId":"string","editFormLabel":{"ru":"Номер договора","en":"Contract number"},"showFilter":"E","settings":{"maxLength":50}}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.smartprocess1038.field.custom.add

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"name":"UF_CRM_CONTRACT_NUMBER","userTypeId":"string","editFormLabel":{"ru":"Номер договора","en":"Contract number"},"showFilter":"E","settings":{"maxLength":50}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/crm.smartprocess1038.field.custom.add

Методы 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 CustomFieldAddResult = {
  item: {
    id: number
    name: string
    userTypeId: string
    settings: Record<string, unknown>
  }
}

try {
  const response = await $b24.getHttpClient(ApiVersion.v3).call<CustomFieldAddResult>(
    'crm.smartprocess1038.field.custom.add',
    {
      fields: {
        name: 'UF_CRM_CONTRACT_NUMBER',
        userTypeId: 'string',
        editFormLabel: {
          ru: 'Номер договора',
          en: 'Contract number',
        },
        showFilter: 'E',
        settings: {
          maxLength: 50,
        },
      },
    },
    Text.getUuidRfc4122()
  )

  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Field created:', result.item.id, result.item.name)
  }
} 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 addCustomField() {
    try {
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.getHttpClient(B24Js.ApiVersion.v3).call(
        'crm.smartprocess1038.field.custom.add',
        {
          fields: {
            name: 'UF_CRM_CONTRACT_NUMBER',
            userTypeId: 'string',
            editFormLabel: {
              ru: 'Номер договора',
              en: 'Contract number',
            },
            showFilter: 'E',
            settings: {
              maxLength: 50,
            },
          },
        },
        B24Js.Text.getUuidRfc4122()
      )

      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Field created:', result.item.id, result.item.name)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', addCustomField)
</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.add"
Config().configure(api_v3_methods=Config().api_v3_methods | {method})

try:
    response = bitrix_token.call_method(
        api_method=method,
        params={
            "fields": {
                "name": "UF_CRM_CONTRACT_NUMBER",
                "userTypeId": "string",
                "editFormLabel": {
                    "ru": "Номер договора",
                    "en": "Contract number",
                },
                "showFilter": "E",
                "settings": {
                    "maxLength": 50,
                },
            },
        },
        prefer_version=3,
    )
    result = response["result"]
    print(result["item"]["id"], result["item"]["name"])
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.add',
            [
                'fields' => [
                    'name' => 'UF_CRM_CONTRACT_NUMBER',
                    'userTypeId' => 'string',
                    'editFormLabel' => [
                        'ru' => 'Номер договора',
                        'en' => 'Contract number',
                    ],
                    'showFilter' => 'E',
                    'settings' => [
                        'maxLength' => 50,
                    ],
                ],
            ]
        );

    $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.add',
    {
        fields: {
            name: 'UF_CRM_CONTRACT_NUMBER',
            userTypeId: 'string',
            editFormLabel: {
                ru: 'Номер договора',
                en: 'Contract number',
            },
            showFilter: 'E',
            settings: {
                maxLength: 50,
            },
        },
    },
    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.add',
    [
        'fields' => [
            'name' => 'UF_CRM_CONTRACT_NUMBER',
            'userTypeId' => 'string',
            'editFormLabel' => [
                'ru' => 'Номер договора',
                'en' => 'Contract number',
            ],
            'showFilter' => 'E',
            'settings' => [
                'maxLength' => 50,
            ],
        ],
    ]
);

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

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.smartprocess1038.field.custom.add", b24.Params{
	"fields": b24.Params{
		"name":       "UF_CRM_CONTRACT_NUMBER",
		"userTypeId": "string",
		"editFormLabel": b24.Params{
			"ru": "Номер договора",
			"en": "Contract number",
		},
		"showFilter": "E",
		"settings": b24.Params{
			"maxLength": 50,
		},
	},
})
if err != nil {
	return fmt.Errorf("crm.smartprocess1038.field.custom.add: %w", err)
}

var created struct {
	Item struct {
		ID   int    `json:"id"`
		Name string `json:"name"`
	} `json:"item"`
}
if err := json.Unmarshal(res.Result, &created); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(created.Item.ID, created.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": "E",
            "showInList": true,
            "editInList": true,
            "isSearchable": false,
            "settings": {
                "size": 20,
                "rows": 1,
                "regexp": "",
                "minLength": 0,
                "maxLength": 50,
                "defaultValue": ""
            },
            "editFormLabel": "Номер договора",
            "listColumnLabel": null,
            "listFilterLabel": null,
            "errorMessage": null,
            "helpMessage": null
        }
    },
    "time": {
        "start": 1793716013,
        "finish": 1793716014.048628,
        "duration": 1.0486280918121338,
        "processing": 1,
        "date_start": "2026-11-03T17:26:53+03:00",
        "date_finish": "2026-11-03T17:26:54+03:00",
        "operating_reset_at": 1793716560,
        "operating": 0
    }
}

Возвращаемые данные

Название
тип

Описание

result
object

Объект с данными ответа

result.item
object

Описание созданного поля: все параметры поля, в том числе не переданные в запросе, со значениями по умолчанию. Кроме них, объект содержит два ключа:

time
time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_ENTITYALREADYEXISTSEXCEPTION",
        "message": "Запись с идентификатором UF_CRM_CONTRACT_NUMBER уже существует."
    }
}

Название
тип

Описание

error.code
string

Строковый код ошибки. Используйте для идентификации типа исключения

error.message
string

Текстовое описание ошибки

error.validation
array

Массив c деталями ошибки. Присутствует только в ошибках валидации данных BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

error.validation[].field
string

Название поля, в котором возникла ошибка валидации

error.validation[].message
string

Описание ошибки, связанной с указанным полем

Возможные коды ошибок

Ошибки валидации запроса

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Поле

Описание ошибки

Как исправить

fields

Обязательное поле fields не указано

Передайте объект fields

isMultiple

В поле isMultiple требуется тип данных bool для такого запроса

Передайте значение того типа, который указан в описании параметра. Логические параметры принимают только true или false

settings

В поле settings требуется тип данных array для такого запроса

Передайте settings объектом

name

The field name is required.

Передайте непустое имя поля в name

field

Имя поля начинается не с UF_

Начните имя с UF_, например UF_CRM_CONTRACT_NUMBER

field

Имя поля содержит недопустимые символы. Допустимыми являются: A-Z, 0-9 и _.

Используйте в имени только заглавные латинские буквы, цифры и _

field

Имя поля слишком длинное (больше 50-ти символов).

Сократите имя до 50 символов

field

Выберите инфоблок, с которым нужно связать поле

Передайте iblockId в settings для поля iblock_section или iblock_element

Ошибки имени поля и настроек инфоблока приходят с "field": "field", а их текст заканчивается тегом <br>. Если таких ошибок несколько, Битрикс24 объединяет их в одно сообщение.

Ошибки валидации объекта

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION

Поле

Описание ошибки

Как исправить

name

Не заполнено обязательное поле "name"

Передайте name в fields

userTypeId

Не заполнено обязательное поле "userTypeId"

Передайте userTypeId в fields

userTypeId

Значение поля не содержится в списке допустимых значений: #VALUES#

Передайте тип из списка типов. Поля enumeration и file метод не создает

showFilter

Значение поля не содержится в списке допустимых значений: N, I, E, S

Передайте одно из значений N, I, E, S

id

Поле "id" не доступно к заполнению

Уберите id из fields: идентификатор назначается автоматически

entityId

Поле "entityId" не доступно к заполнению

Уберите entityId из fields: тип объекта задает имя метода

Поле уже существует

Код ошибки: BITRIX_REST_V3_EXCEPTION_ENTITYALREADYEXISTSEXCEPTION

Поле

Описание ошибки

Как исправить

-

Запись с идентификатором #NAME# уже существует.

Выберите другое имя поля. Занятые имена возвращает метод crm.<тип>.field.custom.list

Ошибка неизвестного поля

Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Поле

Описание ошибки

Как исправить

-

Неизвестное поле #FIELD# для сущности CustomFieldConfigDto

Проверьте имя параметра по таблице параметра fields. Ошибку с именем поля 0 вызывает fields, переданный строкой или массивом вместо объекта

Ошибка доступа

Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION, HTTP-статус 403

Поле

Описание ошибки

Как исправить

-

Доступ запрещен

Вызовите метод от имени пользователя с правом «Разрешить изменять настройки» в CRM

Метод не найден

Код ошибки: BITRIX_REST_V3_EXCEPTION_METHODNOTFOUNDEXCEPTION, HTTP-статус 404

Поле

Описание ошибки

Как исправить

-

Метод #METHOD# не найден

Проверьте имя метода: оно пишется в нижнем регистре, например crm.smartinvoice.field.custom.add. Для смарт-процесса проверьте entityTypeId методом crm.type.list. У моей компании методов пользовательских полей нет

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Получить описание полей
Следующая
Изменить пользовательское поле