Добавить настраиваемое поле в шаблон реквизитов crm.requisite.preset.field.add

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

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

Scope: crm

Кто может выполнять метод: пользователь с правом на добавление и контактов, и компаний

Метод добавляет настраиваемое поле в шаблон реквизитов. С помощью метода crm.requisite.preset.field.availabletoadd можно получить поля, доступные для добавления в шаблон.

Прежде чем добавить пользовательское поле UF_... в шаблон, его нужно создать при помощи метода crm.requisite.userfield.add или убедиться, что оно существует.

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

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

Название
тип

Описание

preset*
object

Объект, содержащий значение идентификатора шаблона, в который добавляется настраиваемое поле (например, {"ID": 27}).

Идентификаторы шаблонов можно получить с помощью метода crm.requisite.preset.list

fields*
object

Набор полей — объект вида {"поле": "значение"[, ...]} для добавления настраиваемого поля шаблона

Параметр fields

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

Название
тип

Описание

FIELD_NAME*
string

Название поля.

FIELD_TITLE
string

Альтернативное название поля для реквизита.

Альтернативное название отображается в различных формах для заполнения реквизитов. В зависимости от конкретной формы альтернативное название может использоваться или нет

SORT
integer

Сортировка. Порядок в списке полей шаблона

IN_SHORT_LIST
char

Показывать в кратком списке. Устаревшее поле, сейчас не используется. Оставлено для обратной совместимости. Может принимать значения Y или N

Примеры кода

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"preset":{"ID":27},"fields":{"FIELD_NAME":"RQ_NAME","FIELD_TITLE":"TEST","IN_SHORT_LIST":"N","SORT":580}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.preset.field.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"preset":{"ID":27},"fields":{"FIELD_NAME":"RQ_NAME","FIELD_TITLE":"TEST","IN_SHORT_LIST":"N","SORT":580},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.requisite.preset.field.add
// 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<number>({
    method: 'crm.requisite.preset.field.add',
    params: {
      preset: {
        ID: 27, // Template ID
      },
      fields: {
        FIELD_NAME: 'RQ_NAME',
        FIELD_TITLE: 'TEST',
        IN_SHORT_LIST: 'N',
        SORT: 580,
      },
    },
    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('Added field ID:', 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 addPresetField() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'crm.requisite.preset.field.add',
        params: {
          preset: {
            ID: 27, // Template ID
          },
          fields: {
            FIELD_NAME: 'RQ_NAME',
            FIELD_TITLE: 'TEST',
            IN_SHORT_LIST: 'N',
            SORT: 580,
          },
        },
        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('Added field ID:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', addPresetField)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.crm.requisite.preset.field.add(
        preset={
            "ID": 27,
        },
        fields={
            "FIELD_NAME": "RQ_NAME",
            "FIELD_TITLE": "TEST",
            "IN_SHORT_LIST": "N",
            "SORT": 580,
        },
    ).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}")
try {
    $response = $b24Service
        ->core
        ->call(
            'crm.requisite.preset.field.add',
            [
                'preset' => [
                    'ID' => 27, // Идентификатор шаблона
                ],
                'fields' => [ // Объект с описанием настраиваемого поля
                    'FIELD_NAME'    => 'RQ_NAME',
                    'FIELD_TITLE'   => 'TEST',
                    'IN_SHORT_LIST' => 'N',
                    'SORT'          => 580,
                ],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'В шаблон добавлено настраиваемое поле с ID ' . $result;

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Ошибка при добавлении настраиваемого поля: ' . $e->getMessage();
}
BX24.callMethod(
    "crm.requisite.preset.field.add",
    {
        preset:
        {
            "ID": 27    // Идентификатор шаблона
        },
        fields:        // Объект с описанием настраиваемого поля
        {
            "FIELD_NAME": "RQ_NAME",
            "FIELD_TITLE": "TEST",
            "IN_SHORT_LIST": "N",
            "SORT": 580
        }
    },
    function(result)
    {
        if(result.error())
            console.error(result.error());
        else
            console.info("В шаблон добавлено настаиваемое поле с ID " + result.data());
    }
);
require_once('crest.php');

$result = CRest::call(
    'crm.requisite.preset.field.add',
    [
        'preset' => ['ID' => 27],
        'fields' => [
            'FIELD_NAME' => 'RQ_NAME',
            'FIELD_TITLE' => 'TEST',
            'IN_SHORT_LIST' => 'N',
            'SORT' => 580
        ]
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.requisite.preset.field.add", b24.Params{
	"preset": b24.Params{
		"ID": 27,
	},
	"fields": b24.Params{
		"FIELD_NAME":    "RQ_NAME",
		"FIELD_TITLE":   "TEST",
		"IN_SHORT_LIST": "N",
		"SORT":          580,
	},
})
if err != nil {
	return fmt.Errorf("crm.requisite.preset.field.add: %w", err)
}

var newID b24.ID
if err := json.Unmarshal(res.Result, &newID); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("идентификатор:", newID)

Обработка ответа

HTTP-статус: 200

{
    "result": 3,
    "time": {
        "start": 1716811635.108203,
        "finish": 1716811635.503093,
        "duration": 0.39489006996154785,
        "processing": 0.043524980545043945,
        "date_start": "2024-05-27T14:07:15+02:00",
        "date_finish": "2024-05-27T14:07:15+02:00",
        "operating": 0
    }
}

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

Название
тип

Описание

result
integer

Идентификатор добавленного поля

time
time

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

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

HTTP-статус: 40x, 50x

{
    "error": "",
    "error_description": "The field 'RQ_NAME' can not be added."
}

Название
тип

Описание

error
string

Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только error_description

error_description
string

Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

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

Код

Описание

The field 'RQ_NAME' can not be added

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

The Preset with ID '27' is not found

Не найден шаблон с указанным идентификатором

Access denied

Недостаточно прав доступа для добавления настаиваемого поля в шаблон реквизитов

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

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

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

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