Создать шаблон crm.requisite.preset.add

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

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

Scope: crm

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

Метод создает новый шаблон реквизитов.

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

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

Название
тип

Описание

fields*
object

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

Параметр fields

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

Название
тип

Описание

ENTITY_TYPE_ID*
integer

Идентификатор типа родительского объекта. Сейчас это только «Реквизит» (идентификатор 8).

Идентификаторы типов объектов CRM отдает метод crm.enum.ownertype

COUNTRY_ID*
integer

Идентификатор страны, которой соответствует набор полей шаблона реквизитов (для получения доступных значений смотрите метод crm.requisite.preset.countries)

NAME*
string

Название шаблона

XML_ID
string

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

Назначение поля может меняться конечным разработчиком.

Каждое приложение обеспечивает уникальность значений в этом поле. Рекомендуется использовать уникальный префикс для избежания коллизий с другими приложениями.

В CRM зарезервированы значения вида #CRM_REQUISITE_PRESET_DEF_... для идентификации шаблонов, которые используются по умолчанию. Не следует использовать эти идентификаторы для своих целей, так как это может привести к нарушению логики

ACTIVE
char

Признак активности. Используются значения Y или N. Определяет доступность шаблона в списке выбора при добавлении реквизитов

SORT
integer

Сортировка

Примеры кода

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"ENTITY_TYPE_ID":8,"COUNTRY_ID":1,"NAME":"ИП","XML_ID":"EXAMPLE_COMPANY__VALUE_1","ACTIVE":"Y","SORT":520}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.preset.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"ENTITY_TYPE_ID":8,"COUNTRY_ID":1,"NAME":"ИП","XML_ID":"EXAMPLE_COMPANY__VALUE_1","ACTIVE":"Y","SORT":520},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.requisite.preset.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.add',
    params: {
      fields: {
        ENTITY_TYPE_ID: 8,    // For a requisite preset, always use "Requisite" (ID 8), see crm.enum.ownertype
        COUNTRY_ID: 1,        // Russia
        NAME: 'Sole Proprietor',
        XML_ID: 'EXAMPLE_COMPANY__VALUE_1',    // Unique external identifier
        ACTIVE: 'Y',
        SORT: 520,            // Position in the preset list
      },
    },
    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('Created preset with 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 addRequisitePreset() {
    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.add',
        params: {
          fields: {
            ENTITY_TYPE_ID: 8,    // For a requisite preset, always use "Requisite" (ID 8), see crm.enum.ownertype
            COUNTRY_ID: 1,        // Russia
            NAME: 'Sole Proprietor',
            XML_ID: 'EXAMPLE_COMPANY__VALUE_1',    // Unique external identifier
            ACTIVE: 'Y',
            SORT: 520,            // Position in the preset list
          },
        },
        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('Created preset with ID:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

try:
    bitrix_response = client.crm.requisite.preset.add(
        fields={
            "ENTITY_TYPE_ID": 8,
            "COUNTRY_ID": 1,
            "NAME": "ИП",
            "XML_ID": "EXAMPLE_COMPANY__VALUE_1",
            "ACTIVE": "Y",
            "SORT": 520,
        },
    ).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.add',
            [
                'fields' => [
                    'ENTITY_TYPE_ID' => 8,
                    'COUNTRY_ID'     => 1,
                    'NAME'           => 'ИП',
                    'XML_ID'         => 'EXAMPLE_COMPANY__VALUE_1',
                    'ACTIVE'         => 'Y',
                    'SORT'           => 520,
                ],
            ]
        );

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

    echo 'Создан шаблон с ID ' . $result;

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Ошибка при создании шаблона: ' . $e->getMessage();
}
BX24.callMethod(
    "crm.requisite.preset.add",
    {
        fields:
        {
            "ENTITY_TYPE_ID": 8,    // Для шаблона реквизитов всегда указывается "Реквизит" (идентификатор 8), см. crm.enum.ownertype
            "COUNTRY_ID": 1,        // Россия
            "NAME": "ИП",
            "XML_ID": "EXAMPLE_COMPANY__VALUE_1",    // Уникальный внешний идентификатор
            "ACTIVE": "Y",
            "SORT": 520    // Порядок в списке шаблонов
        }
    },
    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.add',
    [
        'fields' =>
        [
            'ENTITY_TYPE_ID' => 8,
            'COUNTRY_ID' => 1,
            'NAME' => 'ИП',
            'XML_ID' => 'EXAMPLE_COMPANY__VALUE_1',
            'ACTIVE' => 'Y',
            'SORT' => 520
        ]
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.requisite.preset.add", b24.Params{
	"fields": b24.Params{
		"ENTITY_TYPE_ID": 8,
		"COUNTRY_ID":     1,
		"NAME":           "ИП",
		"XML_ID":         "EXAMPLE_COMPANY__VALUE_1",
		"ACTIVE":         "Y",
		"SORT":           520,
	},
})
if err != nil {
	return fmt.Errorf("crm.requisite.preset.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": 347,
    "time": {
        "start": 1716543593.35189,
        "finish": 1716543593.683898,
        "duration": 0.33200788497924805,
        "processing": 0.016175031661987305,
        "date_start": "2024-05-24T11:39:53+02:00",
        "date_finish": "2024-05-24T11:39:53+02:00",
        "operating": 0
    }
}

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

Название
тип

Описание

result
integer

Идентификатор созданного шаблона реквизитов

time
time

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

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

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

{
    "error": "",
    "error_description": "ENTITY_TYPE_ID is not defined or invalid"
}

Название
тип

Описание

error
string

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

error_description
string

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

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

Код

Описание

ENTITY_TYPE_ID is not defined or invalid

Идентификатор типа родительского объекта не определен или имеет недопустимое значение

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

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

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