Создать CRM-форму crm.form.add

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

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

Scope: crm

Кто может выполнять метод: пользователь с правом на изменение CRM-форм

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

Метод crm.form.add создает CRM-форму с настройками конструктора.

Через REST нельзя добавить в форму поля с вариантами выбора — список, флажки, переключатели, — а также товары и бронирование. Тему оформления изменить тоже нельзя.

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

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

Название
тип

Описание

fields*
object

Настройки формы, подробное описание

Параметр fields

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

Название
тип

Описание

name*
string

Название формы, до 50 символов

crm*
object

Настройки CRM. Обязательно поле entityScheme — схема CRM, то есть какие объекты создаст заполнение формы. Идентификаторы схем возвращает метод crm.form.configuration.get в ключе entitySchemes.

Необязательные поля раздела — duplicateMode, dealCategoryId, smartProcessCategoryId, dealDuplicateControlEnabled, smartProcessDuplicateControlEnabled — описаны в структуре раздела crm

active
boolean

Активность формы.

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

  • true — форма работает сразу после создания
  • false — форма создается выключенной

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

Активная форма учитывается в лимите активных форм тарифа

fields
array

Поля, которые заполняет клиент, например имя и телефон, в порядке отображения. Это ключ fields внутри параметра fields метода — названия совпадают.

Коды полей должны относиться к объектам схемы crm.entityScheme и не повторяться, подробное описание

languageId
string

Язык формы. Список языков возвращает метод crm.form.configuration.get

templateId
string

Сценарий формы. Список сценариев возвращает метод crm.form.scenario.list

appearance
object

Заголовок, описание и кнопка. Поля title, description, buttonCaption, buttonTextColor, buttonBackgroundColor, copyrightRemoved описаны в структуре раздела appearance

responsible
object

Очередь ответственных. Поля userIds, checkWorkTime описаны в структуре раздела responsible

agreements
object

Соглашения. Поля enabled, items описаны в структуре раздела agreements

submission
object

Сообщения и перенаправление после отправки. Поля success, failure, redirectDelay, refill описаны в структуре раздела submission

dependencies
array

Правила зависимых полей. Элемент — группа правил с полями logic и rules, у каждого правила есть condition и action. Описание — в структуре элемента dependencies

presetFields
array

Значения полей CRM, которые форма заполнит автоматически. Элемент с полями entityName, fieldName, value описан в структуре элемента presetFields

payment
object

Оплата после заполнения формы. Поля enabled, disabledPaySystemsId описаны в структуре раздела payment

callback
object

Обратный звонок после заполнения формы. Поля enabled, from, text описаны в структуре раздела callback

analytics
object

Счетчики веб-аналитики. Поля googleAnalyticsId, googleAnalyticsPageViewEnabled, yandexMetricaId описаны в структуре раздела analytics

spamProtection
object

Защита от спама: поле enabled типа boolean

integrations
object

Форма в мессенджере и связи с рекламными сервисами. Поля whatsAppEnabled, ads описаны в структуре раздела integrations

Элемент fields.fields

Один элемент массива — одно поле формы. Порядок полей задается порядком элементов, поле sort передавать не нужно.

Название
тип

Описание

name
string

Код поля, например LEAD_NAME. Коды полей CRM возвращает метод crm.form.entityfield.list. Поле должно относиться к объектам схемы crm.entityScheme. Один код можно указать в форме один раз

type
string

Тип поля, например string, phone, email. Список типов возвращает метод crm.form.configuration.get в ключе fieldTypes.

Через REST пока нельзя добавить поля с вариантами выбора и товары: list, checkbox, radio, product, booking. Такие поля, созданные в интерфейсе, сохраняются при записи, если не менять их тип

label
string

Подпись поля

required
boolean

Обязательность поля.

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

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

multiple
boolean

Можно ли ввести несколько значений.

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

  • true — несколько значений
  • false — одно значение

placeholder
string

Подсказка внутри пустого поля

valueType
string

Тип значения для полей контактов, например рабочий или мобильный телефон

value
string

Значение по умолчанию

Поля id, code, system, createdTime, updatedTime, activeChangedById, activeChangedTime, booking, appearance.backgroundImageId и fields[].sort только для чтения: передавать их нельзя.

Примеры кода

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

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

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

Пример создает выключенную форму, которая создает лид из имени и телефона.

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"name":"Заявка на консультацию","active":false,"crm":{"entityScheme":1},"fields":[{"name":"LEAD_NAME","type":"string","label":"Имя","required":true},{"name":"LEAD_PHONE","type":"phone","label":"Телефон","required":true}]}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.form.add

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"name":"Заявка на консультацию","active":false,"crm":{"entityScheme":1},"fields":[{"name":"LEAD_NAME","type":"string","label":"Имя","required":true},{"name":"LEAD_PHONE","type":"phone","label":"Телефон","required":true}]},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/crm.form.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

// Shape of the payload returned in result (match the "response handling" section of the page)
type FormAddResult = {
  id: number
}

try {
  const response = await $b24.actions.v3.call.make<FormAddResult>({
    method: 'crm.form.add',
    params: {
      fields: {
        name: 'Заявка на консультацию',
        active: false,
        crm: {
          entityScheme: 1,
        },
        fields: [
          {
            name: 'LEAD_NAME',
            type: 'string',
            label: 'Имя',
            required: true,
          },
          {
            name: 'LEAD_PHONE',
            type: 'phone',
            label: 'Телефон',
            required: true,
          },
        ],
      },
    },
    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(result.id)
  }
} 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 addForm() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v3.call.make({
        method: 'crm.form.add',
        params: {
          fields: {
            name: 'Заявка на консультацию',
            active: false,
            crm: {
              entityScheme: 1,
            },
            fields: [
              {
                name: 'LEAD_NAME',
                type: 'string',
                label: 'Имя',
                required: true,
              },
              {
                name: 'LEAD_PHONE',
                type: 'phone',
                label: 'Телефон',
                required: true,
              },
            ],
          },
        },
        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(result.id)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', addForm)
</script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

# client = Client(token, prefer_version=3)

try:
    bitrix_response = client.crm.form.add(
        fields={
            "name": "Заявка на консультацию",
            "active": False,
            "crm": {
                "entityScheme": 1,
            },
            "fields": [
                {
                    "name": "LEAD_NAME",
                    "type": "string",
                    "label": "Имя",
                    "required": True,
                },
                {
                    "name": "LEAD_PHONE",
                    "type": "phone",
                    "label": "Телефон",
                    "required": True,
                },
            ],
        },
    ).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}")

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

try {
    $response = $b24Service
        ->core
        ->call(
            'crm.form.add',
            [
                'fields' => [
                    'name' => 'Заявка на консультацию',
                    'active' => false,
                    'crm' => [
                        'entityScheme' => 1,
                    ],
                    'fields' => [
                        [
                            'name' => 'LEAD_NAME',
                            'type' => 'string',
                            'label' => 'Имя',
                            'required' => true,
                        ],
                        [
                            'name' => 'LEAD_PHONE',
                            'type' => 'phone',
                            'label' => 'Телефон',
                            'required' => true,
                        ],
                    ],
                ],
            ]
        );

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

    if ($result->error()) {
        error_log($result->error());
    } else {
        echo 'Success: ' . print_r($result->data(), true);
    }

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error: ' . $e->getMessage();
}

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

BX24.callMethod(
    'crm.form.add',
    {
      fields: {
        name: 'Заявка на консультацию',
        active: false,
        crm: {
          entityScheme: 1,
        },
        fields: [
          {
            name: 'LEAD_NAME',
            type: 'string',
            label: 'Имя',
            required: true,
          },
          {
            name: 'LEAD_PHONE',
            type: 'phone',
            label: 'Телефон',
            required: true,
          },
        ],
      },
    },
    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.form.add',
    [
        'fields' => [
            'name' => 'Заявка на консультацию',
            'active' => false,
            'crm' => [
                'entityScheme' => 1,
            ],
            'fields' => [
                [
                    'name' => 'LEAD_NAME',
                    'type' => 'string',
                    'label' => 'Имя',
                    'required' => true,
                ],
                [
                    'name' => 'LEAD_PHONE',
                    'type' => 'phone',
                    'label' => 'Телефон',
                    'required' => true,
                ],
            ],
        ],
    ]
);

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

// client и ctx уже созданы, базовый адрес клиента содержит /rest/api/
res, err := client.Core().Call(ctx, "crm.form.add", b24.Params{
	"fields": map[string]any{
		"name": "Заявка на консультацию",
		"active": false,
		"crm": map[string]any{
			"entityScheme": 1,
		},
		"fields": []any{
			map[string]any{
				"name": "LEAD_NAME",
				"type": "string",
				"label": "Имя",
				"required": true,
			},
			map[string]any{
				"name": "LEAD_PHONE",
				"type": "phone",
				"label": "Телефон",
				"required": true,
			},
		},
	},
})
if err != nil {
	return fmt.Errorf("crm.form.add: %w", err)
}

var data struct {
	ID int `json:"id"`
}
if err := json.Unmarshal(res.Result, &data); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(data.ID)

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

HTTP-статус: 200

{
    "result": {
        "id": 47
    },
    "time": {
        "start": 1792593840,
        "finish": 1792593842.660519,
        "duration": 2.6605188846588135,
        "processing": 2,
        "date_start": "2026-10-21T17:44:00+03:00",
        "date_finish": "2026-10-21T17:44:02+03:00",
        "operating_reset_at": 1792594440,
        "operating": 2.563063859939575
    }
}

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

Название
тип

Описание

result
object

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

id
integer

Идентификатор созданной формы

time
time

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

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

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
        "message": "Ошибка при валидации объекта запроса",
        "validation": [
            {
                "message": "Name of the CRM form is required",
                "field": "name"
            },
            {
                "message": "CRM scheme of the form can not be used",
                "field": "crm.entityScheme"
            }
        ]
    }
}

Название
тип

Описание

error.code
string

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

error.message
string

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

error.validation
array

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

error.validation[].field
string

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

error.validation[].message
string

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

Метод возвращает все нарушения конфигурации сразу. В поле field указан путь к значению запроса, например crm.entityScheme или fields[1].name. Сообщения проверки конфигурации приходят на английском языке.

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

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

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

HTTP-статус: 400

Поле

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

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

fields

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

Передайте настройки формы в fields

name

Name of the CRM form is required

Передайте название формы

name

Name of the CRM form is longer than 50 characters

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

crm.entityScheme

CRM scheme of the form is required

Передайте схему CRM

crm.entityScheme

CRM scheme of the form can not be used

Возьмите идентификатор схемы из ответа crm.form.configuration.get

fields[N].type

A field of type list can not be created through this contract: the variants it offers are not part of it

Не добавляйте через REST поля типов list, checkbox, radio, product, booking

fields[N].name

Form field LEAD_NAME is specified more than once

Укажите каждый код поля один раз

fields[N].name

CRM field #NAME# is not part of the scheme of the form

Используйте поля объектов выбранной схемы из ответа crm.form.entityfield.list

booking

booking is published for reading only

Не передавайте поля только для чтения

payment.enabled

Payment is not available on this portal

Оплата недоступна на этом Битрикс24

callback.enabled

Callback is not available on this portal

Обратный звонок недоступен на этом Битрикс24

integrations.whatsAppEnabled

Messenger forms are not available on this portal

Формы в мессенджере недоступны на этом Битрикс24

callback.from

This number can not be called from on this portal

Укажите номер телефонии этого Битрикс24

Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

HTTP-статус: 400

Поле

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

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

fields

Неизвестное поле sort для сущности FormDto

Передайте только поля из раздела Структура CRM-формы

Форма создана частично

Код ошибки: CRM_FORM_PARTIALLY_CREATED

HTTP-статус: 400

Поле

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

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

-

CRM-форма создана, но не все данные сохранены: исправьте поля и обновите форму по ее ID

В ответе есть ключ id созданной формы. Не создавайте форму повторно: исправьте поля из validation и обновите форму методом crm.form.update

Ограничения тарифа

Код ошибки: CRM_FORM_WRITE_RESTRICTED

HTTP-статус: 402

Поле

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

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

-

На этом тарифе нельзя изменять CRM-формы

Смените тариф Битрикс24

Код ошибки: CRM_FORM_ACTIVATION_LIMIT_REACHED

HTTP-статус: 402

Поле

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

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

-

Достигнут лимит активных CRM-форм на этом тарифе: выключите ненужную форму и повторите запрос

Создайте форму с active: false или выключите другую форму методом crm.form.deactivate

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

Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

HTTP-статус: 403

Поле

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

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

-

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

Проверьте, что у пользователя есть право на изменение CRM-форм

Код ошибки: CRM_FORM_PHONE_VERIFICATION_REQUIRED

HTTP-статус: 403

Поле

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

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

-

Подтвердите номер телефона в Битрикс24, чтобы работать с CRM-формами

Подтвердите номер телефона в Битрикс24 и повторите запрос

Код ошибки: CRM_FORM_MODULE_UNAVAILABLE

HTTP-статус: 403

Поле

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

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

-

Чтобы выполнить действие, установите модуль «#MODULE#»

Установите модуль из сообщения

Ошибка после сохранения

Код ошибки: CRM_FORM_SIDE_EFFECT_FAILED

HTTP-статус: 500

Поле

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

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

-

Не удалось завершить действие, но данные CRM-формы уже изменены: проверьте состояние формы перед повторной попыткой

Получите форму методом crm.form.get и проверьте ее состояние

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

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

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

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

Предыдущая
Проверить конфигурацию CRM-формы
Следующая
Изменить CRM-форму