Типы данных и структура объектов в REST API CRM-форм

Объект

Когда использовать

Методы

crm_form

Для чтения, создания и изменения CRM-формы: поля, схема CRM, оформление, соглашения, действия после отправки, интеграции

crm.form.*

crm_form_configuration

Для получения значений, которые нужны при создании формы: схемы CRM, воронки, типы полей, языки, платежные системы, права и лимит активных форм

crm.form.configuration.get

crm_form_scenario

Для выбора готового сценария формы

crm.form.scenario.list

crm_form_scenario_category

Для группировки сценариев по категориям

crm.form.scenariocategory.list

crm_form_entity_field

Для выбора полей объектов CRM, из которых собирается форма

crm.form.entityfield.list

crm_form_embedding

Для получения кода размещения на сайте, публичной ссылки и настроек кнопки и автопоказа

crm.form.embedding.*

crm_form_embedding_selection

Для получения кода одного варианта размещения

crm.form.embedding.get

crm_form_site_button

Для проверки, к каким виджетам на сайт подключена форма

crm.form.sitebutton.list

crm_form_open_line

Для проверки, в каких открытых линиях форма приветственная

crm.form.openline.list

Тип

Описания и значения

crm_form.id

Целочисленный идентификатор CRM-формы, например 45. Получить идентификаторы форм можно методом crm.form.list

crm_form.updatedTime

Версия формы — дата и время последнего изменения в формате ISO 8601, например 2026-10-21T17:44:00+03:00. Получить можно методом crm.form.get. Обязательна в crm.form.update и crm.form.embedding.update

crm_form_configuration.entitySchemes.id

Целочисленный идентификатор схемы CRM, например 1 — лид. Передается в crm.entityScheme. Получить можно методом crm.form.configuration.get

crm_form_configuration.dealCategories.id

Целочисленный идентификатор воронки сделок, 0 — общая воронка. Передается в crm.dealCategoryId

crm_form_configuration.smartProcesses.categories.id

Целочисленный идентификатор воронки смарт-процесса. Передается в crm.smartProcessCategoryId

crm_form_configuration.fieldTypes.id

Строковый код типа поля формы, например string или phone. Передается в fields[].type

crm_form_configuration.languages.id

Строковый код языка формы, например ru. Передается в languageId

crm_form_configuration.paySystems.id

Целочисленный идентификатор платежной системы. Передается в payment.disabledPaySystemsId

crm_form_scenario.id

Строковый код сценария, например contacts или callback. Передается в templateId. Получить можно методом crm.form.scenario.list

crm_form_scenario_category.id

Строковый код категории сценариев, например crm. Получить можно методом crm.form.scenariocategory.list

crm_form_entity_field.name

Строковый код поля объекта CRM, например LEAD_NAME. Передается в fields[].name. Получить можно методом crm.form.entityfield.list

crm_form_site_button.id

Целочисленный идентификатор виджета на сайт. Получить можно методом crm.form.sitebutton.list

crm_form_open_line.id

Целочисленный идентификатор открытой линии. Получить можно методом crm.form.openline.list

Название
тип

Описание

Запись

id
integer

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

Только чтение

code
string

Символьный код формы

Только чтение

name
string

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

Обязательно при создании

active
boolean

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

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

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

Передается только в crm.form.add, по умолчанию true. У созданной формы активность меняют методы crm.form.activate и crm.form.deactivate

Только при создании

system
boolean

Признак системной формы. Системную форму нельзя изменить или удалить

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

• true — форма системная
• false — форма создана пользователем

Только чтение

languageId
string

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

Да

templateId
string

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

Да

createdTime
datetime

Дата и время создания формы

Только чтение

updatedTime
datetime

Версия формы — дата и время последнего изменения. Передается в updatedTime методов изменения, чтобы не перезаписать чужие изменения

Только чтение

activeChangedById
integer

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

Только чтение

activeChangedTime
datetime

Дата и время последнего включения или выключения формы

Только чтение

appearance
object

Заголовок, описание и кнопка формы. Структура раздела

Да

crm
object

Какие объекты CRM создает форма. Структура раздела

Да

fields
array

Поля формы. Структура элемента описана ниже

Да

dependencies
array

Правила зависимых полей. Структура элемента

Да

presetFields
array

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

Да

responsible
object

Очередь ответственных. Структура раздела

Да

agreements
object

Соглашения, которые принимает клиент. Структура раздела

Да

submission
object

Что видит клиент после отправки формы. Структура раздела

Да

payment
object

Оплата после заполнения формы. Структура раздела

Да

callback
object

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

Да

booking
object

Онлайн-запись. Содержит поле enabled типа boolean: true, если в форме есть поле бронирования

Только чтение

analytics
object

Счетчики веб-аналитики. Структура раздела

Да

spamProtection
object

Защита от спама. Содержит поле enabled типа boolean: true — защита включена, false — выключена

Да

integrations
object

Интеграции с мессенджерами и рекламными сервисами. Структура раздела

Да

Название
тип

Описание

Запись

title
string

Заголовок формы

Да

description
string

Описание под заголовком

Да

buttonCaption
string

Текст кнопки отправки

Да

buttonTextColor
string

Цвет текста кнопки

Да

buttonBackgroundColor
string

Цвет фона кнопки

Да

backgroundImageId
integer

Идентификатор фонового изображения

Только чтение

copyrightRemoved
boolean

Скрыта ли надпись «Заряжено Битрикс24».

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

• true — надпись скрыта
• false — надпись показывается

Если тариф не позволяет убрать надпись, значение true без ошибки сохраняется как false

Да

Название
тип

Описание

Запись

entityScheme
integer

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

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

Обязательно при создании

duplicateMode
string

Что делать, если клиент уже есть в CRM.

Возможные значения из ключа duplicateModes метода crm.form.configuration.get:

• MERGE — объединять данные
• REPLACE — заменять данные

Да

dealCategoryId
integer

Воронка сделок. 0 — общая воронка, null — воронка не указана. Идентификаторы воронок возвращает метод crm.form.configuration.get в ключе dealCategories

Да

dealDuplicateControlEnabled
boolean

Контроль дублей для сделок.

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

• true — контроль включен
• false — контроль выключен

Да

smartProcessCategoryId
integer

Воронка смарт-процесса. Идентификаторы воронок возвращает метод crm.form.configuration.get в ключе smartProcesses[].categories

Да

smartProcessDuplicateControlEnabled
boolean

Контроль дублей для элементов смарт-процесса.

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

• true — контроль включен
• false — контроль выключен

Да

Название
тип

Описание

Запись

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

Подпись поля

Да

sort
integer

Порядок поля. Вычисляется по позиции элемента в массиве fields

Только чтение

required
boolean

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

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

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

Да

multiple
boolean

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

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

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

Да

placeholder
string

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

Да

valueType
string

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

Да

value
string

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

Да

Название
тип

Описание

logic
string

Как объединяются правила группы.

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

• and — должны выполниться все правила
• or — достаточно одного правила

rules
array

Правила группы. В группе должно быть хотя бы одно правило. Каждое правило содержит объекты condition и action

rules[].condition.fieldName
string

Код поля формы, за которым следит правило. Поле должно быть в fields этой формы

rules[].condition.event
string

Событие поля. Возможное значение: change — значение изменилось

rules[].condition.operation
string

Сравнение.

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

• = — равно
• != или <> — не равно
• >, >=, <, <= — больше, больше или равно, меньше, меньше или равно — для числовых полей
• empty — не заполнено
• any — заполнено
• contain — содержит — для строковых полей
• !contain — не содержит — для строковых полей

rules[].condition.value
string

Значение для сравнения

rules[].action.fieldName
string

Код поля формы, на которое действует правило

rules[].action.type
string

Действие.

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

• show — показать поле
• hide — скрыть поле

rules[].action.value
string

Значение действия

Название
тип

Описание

entityName
string

Объект CRM, например LEAD

fieldName
string

Код поля объекта

value
string

Значение, которое форма запишет в поле

Название
тип

Описание

userIds
integer[]

Идентификаторы ответственных в порядке очереди. Идентификатор нельзя повторять. Идентификаторы пользователей можно получить методом user.get

checkWorkTime
boolean

Учитывать ли рабочее время при выборе следующего ответственного.

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

• true — учитывать
• false — не учитывать

Название
тип

Описание

enabled
boolean

Показывать ли соглашения в форме.

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

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

items
array

Соглашения. Каждый элемент содержит:

• agreementId — идентификатор соглашения
• checked — отмечено ли соглашение заранее
• required — обязательно ли принять соглашение

Название
тип

Описание

success
object

Результат успешной отправки: url — адрес перенаправления, text — текст сообщения. Если указаны и url, и повторное заполнение refill, приоритет у адреса

failure
object

Результат ошибки отправки: url — адрес перенаправления, text — текст сообщения

redirectDelay
integer

Задержка перед перенаправлением после успешной отправки, от 0 до 10 секунд

refill
object

Предложение заполнить форму еще раз: enabled — включено ли предложение, caption — текст кнопки

Название
тип

Описание

enabled
boolean

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

disabledPaySystemsId
integer[]

Платежные системы, которые форма не предлагает. Все остальные платежные системы Битрикс24 доступны, в том числе подключенные позже. Пустой массив включает все платежные системы. Идентификаторы возвращает метод crm.form.configuration.get в ключе paySystems

Название
тип

Описание

enabled
boolean

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

from
string

Номер, с которого Битрикс24 перезванивает клиенту. Номер должен быть среди номеров телефонии Битрикс24

text
string

Текст, который клиент услышит при звонке

Название
тип

Описание

googleAnalyticsId
string

Идентификатор Google Analytics

googleAnalyticsPageViewEnabled
boolean

Отправлять ли просмотры страницы в Google Analytics

yandexMetricaId
string

Идентификатор счетчика Яндекс Метрики

Название
тип

Описание

whatsAppEnabled
boolean

Включена ли форма в мессенджере. Включить можно, если функция доступна на Битрикс24

ads
array

Связи с формами рекламных сервисов. Каждый элемент содержит:

• direction — направление обмена
• providerCode — код рекламного сервиса
• accountId и accountName — идентификатор и имя рекламного аккаунта
• formId и formName — идентификатор и имя формы в рекламном сервисе
• fieldMappings — соответствие полей: crmFieldName — поле CRM, adsFieldName — поле рекламной формы

Название
тип

Описание

entitySchemes
object[]

Схемы создания объектов CRM: какие объекты создает заполненная форма (подробное описание).

Идентификатор схемы передается в поле crm.entityScheme при создании и изменении формы

duplicateModes
object[]

Режимы обработки повторного заполнения формы: элементы с полями id и name.

Значение id передается в поле crm.duplicateMode. На тестовом Битрикс24 возвращаются MERGE — объединять и REPLACE — заменять

lead
object

Объект с полем enabled типа boolean:

• true — в CRM включены лиды
• false — CRM работает в простом режиме без лидов

dealCategories
object[]

Воронки сделок: элементы с полями id и name.

Значение id передается в поле crm.dealCategoryId. Общая воронка имеет идентификатор 0

smartProcesses
object[]

Смарт-процессы, элементы которых может создавать форма (подробное описание)

languages
object[]

Языки формы: элементы с полями id и name.

Значение id передается в поле languageId

currencies
object[]

Валюты Битрикс24 (подробное описание)

fieldTypes
object[]

Типы полей, из которых можно собрать форму (подробное описание).

Значение id передается в поле fields[].type

paySystems
object[]

Платежные системы, через которые можно оплатить заполненную форму: элементы с полями id и name.

Идентификаторы систем, которые форма не должна предлагать, передаются в поле payment.disabledPaySystemsId. Если на Битрикс24 нет модуля sale, массив пустой

permissions
object

Права текущего пользователя на CRM-формы:

• canRead — может просматривать формы
• canEdit — может создавать, изменять и удалять формы

limits
object

Объект с полем activeForms — лимит активных форм:

• current — сколько форм сейчас активно
• maximum — сколько форм можно держать активными на тарифе

Если количество активных форм на Битрикс24 не ограничено, activeForms равно null

product
object

Сведения о продукте:

• isCloud — облачный Битрикс24
• isRegionRussian — Битрикс24 российского региона

region
string

Код региона Битрикс24, например ru

Название
тип

Описание

id
integer

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

name
string

Название схемы

description
string

Описание схемы: какие объекты она создает

entityNames
string[]

Коды объектов CRM, которые создает схема, например LEAD, CONTACT, COMPANY, DYNAMIC_174.

Коды передаются в фильтр метода crm.form.entityfield.list, чтобы получить поля для формы

mainEntityName
string

Код основного объекта схемы. Для схемы «Клиент» — null

hasInvoice
boolean

Признак того, что схема создает счет

dynamic
boolean

Признак схемы смарт-процесса

Название
тип

Описание

entityTypeId
integer

Идентификатор типа смарт-процесса

entityName
string

Код смарт-процесса, например DYNAMIC_177

name
string

Название смарт-процесса

categories
object[]

Воронки смарт-процесса: элементы с полями id и name.

Значение id передается в поле crm.smartProcessCategoryId

Название
тип

Описание

id
string

Код валюты, например RUB

fullName
string

Название валюты

formatString
string

Шаблон вывода суммы, # заменяется суммой

Название
тип

Описание

id
string

Код типа поля формы, например string, phone, email, section, hr

name
string

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

parameters
string[]

Параметры, которые можно задать полю этого типа в элементе fields[], например label, required, multiple, placeholder, valueType, value. Для разделителей hr и br массив пустой

Название
тип

Описание

id
string

Код сценария, например callback, contacts, event_registration

title
string

Название сценария

description
string

Описание сценария или null

categoryId
string

Код категории сценария. Названия категорий возвращает метод crm.form.scenariocategory.list

iconUrl
string

Путь к иконке сценария на Битрикс24 или null, если иконки нет

sections
string[]

Разделы конструктора, которые сценарий открывает для настройки, например fields, agreements, crm, design

expertSections
string[]

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

defaultSection
string

Раздел, с которого открывается конструктор, или null

openable
boolean

Признак того, что сценарий открывает конструктор формы.

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

• true — сценарий открывает конструктор
• false — сценарий не открывает конструктор, а выполняет действие из actions

soon
boolean

Признак анонсированного сценария.

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

• true — сценарий анонсирован, но пока недоступен
• false — сценарий доступен

actions
string[]

Дополнительные действия сценария, например showHelp или check. Для большинства сценариев массив пустой

Название
тип

Описание

id
string

Код категории. Совпадает с полем categoryId сценария из crm.form.scenario.list

title
string

Название категории

Название
тип

Описание

name
string

Код поля, например CONTACT_NAME. Передается в fields[].name при создании или изменении формы

label
string

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

type
string

Тип поля, например string, typed_string, list, date, file, address. Поля с типами list и checkbox в форму через REST добавить нельзя

required
boolean

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

multiple
boolean

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

entityName
string

Код объекта CRM, которому принадлежит поле

entityLabel
string

Название объекта CRM

items
object[]

Варианты значений поля-списка: элементы с полями id — значение, которое сохраняется в CRM, и label — название варианта. Для остальных полей массив пустой

Название
тип

Описание

formActive
boolean

Активна ли форма.

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

• true — форма активна и принимает заполнения
• false — форма выключена. Включить ее можно методом crm.form.activate

resourcesReady
boolean

Собраны ли файлы формы для публикации.

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

• true — файлы собраны, коды размещения готовы
• false — файлы еще не собраны, у всех вариантов code равен null

publicUrl
string

Публичная ссылка на форму

inline
object

Вариант встраивания формы в страницу сайта. У варианта нет настроек, поэтому settings и options равны null, подробное описание

click
object

Вариант показа формы по клику на кнопку или ссылку, подробное описание

auto
object

Вариант автоматического показа формы через заданное время, подробное описание

Название
тип

Описание

code
string

HTML-код для вставки на сайт. Равен null, пока файлы формы не собраны

previewUrl
string

Ссылка на предпросмотр формы в этом варианте размещения

settings
object

Текущие настройки показа. Есть только у вариантов click и auto, подробное описание

options
object

Допустимые значения настроек показа. Есть только у вариантов click и auto, подробное описание

Название
тип

Описание

type
string

Вид окна формы.

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

• popup — всплывающее окно
• panel — боковая панель

position
string

Положение окна по горизонтали.

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

• left — слева
• center — по центру
• right — справа

vertical
string

Положение окна по вертикали.

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

• bottom — снизу
• top — сверху

delay
integer

Задержка автопоказа в секундах. Есть только у варианта auto

button
object

Настройки кнопки, по которой открывается форма. Есть только у варианта click, подробное описание

Название
тип

Описание

use
boolean

Показывать ли кнопку Битрикс24 на сайте.

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

• true — показывать кнопку с настройками из этого объекта
• false — не показывать кнопку

text
string

Текст кнопки

font
string

Шрифт кнопки. Допустимые значения перечислены в click.options.button.font, например modern, classic, elegant

align
string

Выравнивание кнопки. Допустимые значения перечислены в click.options.button.align, например inline, left, center, right

plain
boolean

Признак кнопки без фона.

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

• true — кнопка без фона
• false — кнопка с фоном

rounded
boolean

Признак скругленных углов.

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

• true — углы скруглены
• false — углы прямые

outlined
boolean

Признак обводки кнопки.

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

• true — у кнопки есть обводка
• false — обводки нет

decoration
string

Подчеркивание текста кнопки. В интерфейсе доступны значения dotted, solid или пустое значение

color
object

Цвета кнопки в формате HEX, например #3bc8f5 или #3eddffa6 с прозрачностью:

• text — цвет текста
• textHover — цвет текста при наведении
• background — цвет фона
• backgroundHover — цвет фона при наведении

Название
тип

Описание

type
string[]

Допустимые значения settings.type

position
string[]

Допустимые значения settings.position

vertical
string[]

Допустимые значения settings.vertical

delay
integer[]

Допустимые значения settings.delay. Есть только у варианта auto

button
object

Допустимые значения настроек кнопки: font и align. Есть только у варианта click

Название
тип

Описание

variant
string

Выбранный вариант размещения: inline, click, auto или link

code
string

HTML-код для вставки на сайт. Возвращается для вариантов inline, click и auto

url
string

Публичная ссылка на форму. Возвращается для варианта link

Название
тип

Описание

formId
integer

Идентификатор CRM-формы из фильтра запроса

id
integer

Идентификатор виджета

name
string

Название виджета

system
boolean

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

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

• true — виджет создан Битрикс24 автоматически
• false — виджет создан пользователем

bound
boolean

Подключена ли форма из фильтра к этому виджету.

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

• true — форма есть в активном слоте виджета
• false — форма к виджету не подключена

formsId
integer[]

Идентификаторы всех CRM-форм, подключенных к виджету

previewUrl
string

Ссылка на предпросмотр виджета. Форма из фильтра видна в предпросмотре, только если bound равно true

Название
тип

Описание

formId
integer

Идентификатор CRM-формы из фильтра запроса

id
integer

Идентификатор открытой линии

name
string

Название открытой линии

bound
boolean

Является ли форма из фильтра приветственной формой этой линии.

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

• true — форма назначена приветственной
• false — форма не назначена приветственной

welcomeFormEnabled
boolean

Включена ли в линии приветственная форма: эта или другая.

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

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

welcomeFormId
integer

Идентификатор приветственной формы линии. Равен null, если форма не выбрана

welcomeFormDelayed
boolean

Когда показывается приветственная форма.

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

• true — после первого сообщения посетителя
• false — до первого сообщения посетителя

previewUrl
string

Ссылка на предпросмотр виджета на сайт с этой открытой линией. Равна null, если линия не подключена ни к одному активному виджету. Форма из фильтра видна в предпросмотре, только если bound равно true