# crm.requisite.preset.field.add

URL: https://chugunov.pro/api-bitrix24/crm/requisites/presets/fields/crm-requisite-preset-field-add/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

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

## Описание

Метод добавляет настраиваемое поле в шаблон реквизитов. С помощью метода [crm.requisite.preset.field.availabletoadd](https://chugunov.pro/api-bitrix24/crm/requisites/presets/fields/crm-requisite-preset-field-available-to-add/) можно получить поля, доступные для добавления в шаблон. 

Прежде чем добавить пользовательское поле `UF_...` в шаблон, его нужно создать при помощи метода [crm.requisite.userfield.add](https://chugunov.pro/api-bitrix24/crm/requisites/user-fields/crm-requisite-userfield-add/) или убедиться, что оно существует.

## Параметры

- `preset` `object` — обязательный. Объект, содержащий значение идентификатора шаблона, в который добавляется настраиваемое поле (например, `{"ID": 27}`). 
  Идентификаторы шаблонов можно получить с помощью метода [crm.requisite.preset.list](https://chugunov.pro/api-bitrix24/crm/requisites/presets/crm-requisite-preset-list/)
- `fields` `object` — обязательный. Набор полей — объект вида `{"поле": "значение"[, ...]}` для добавления настраиваемого поля шаблона

### Параметр fields

- `FIELD_NAME` `string` — обязательный. Название поля.
- `FIELD_TITLE` `string` — необязательный. Альтернативное название поля для реквизита.
  Альтернативное название отображается в различных формах для заполнения реквизитов. В зависимости от конкретной формы альтернативное название может использоваться или нет
- `SORT` `integer` — необязательный. Сортировка. Порядок в списке полей шаблона
- `IN_SHORT_LIST` `char` — необязательный. Показывать в кратком списке. Устаревшее поле, сейчас не используется. Оставлено для обратной совместимости. Может принимать значения `Y` или `N`

## Ответ

HTTP-статус: 200

```json
{
    "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`. Информация о времени выполнения запроса

## Ошибки

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

- `The field 'RQ_NAME' can not be added` — Поле не может быть добавлено. Возможно, поле уже есть в шаблоне или же оно не доступно для страны, к которой относится шаблон
- `The Preset with ID '27' is not found` — Не найден шаблон с указанным идентификатором
- `Access denied` — Недостаточно прав доступа для добавления настаиваемого поля в шаблон реквизитов

## Примеры запроса

### cURL (Webhook)

```bash
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 (OAuth)

```bash
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
```

### JS (TS)

```ts
// 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)
}
```

### JS (UMD)

```html
<!-- 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>
```

### Python

```python
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}")
```

### PHP

```php
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.js

```js
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());
    }
);
```

### PHP CRest

```php
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>';
```

### Go

```go
// 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)
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-add.html