Пользовательские поля звонков, заявок и сделок в API

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

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

Чтобы иметь возможность добавлять значения пользовательских полей к звонкам, заявкам или сделкам - необходимо сначала добавить набор полей, которые будут использоваться. Для этого необходимо перейти в раздел   Интеграции /   Отправка данных во внешние системы / API и Webhooks / API. Добавление пользовательских полей доступно в блоке "Пользовательские поля в API":

При клике на кнопку "Добавить поле" откроется форма добавления пользовательского поля:

Для создания пользовательского поля необходимо указать:

• Название поля в ЛК. Так будет отображаться название поля в отчетах и журналах, фильтрах и настройках пользовательских метрик. Любые символы, максимум 100.
• Название поля в API. По этому значению с данным полем можно будет работать по API. Разрешены только английские буквы и символы дефиса и нижнего подчеркивания.
• Формат поля. Значения пользовательских полей, которые будут передаваться в добавляемом поле, могут быть форматов: число, текст или дата:
• В числовое пользовательское поле вы можете передавать любое целое значение, в том числе отрицательное, максимальное кол-во знаков 38.
• В текстовое пользовательское поле вы можете передавать любое значение, максимальное кол-во знаков 100.
• В пользовательское поле с датой вы можете передать дату, в формате "DD-MM-YYYY" или "DD-MM-YYYY hh:mm:ss".
• Указание, где данное поле будет использоваться. Выберите сущности (звонок, заявка или сделка),  в рамках которых вы планируете использовать данное пользовательское поле. 

После заполнения всех полей формы — нажмите кнопку "Добавить". Пользовательское поле будет добавлено и с этого момента станет доступно для использования его в рамках API запросов по управлению пользовательскими полями звонков, заявок и сделок.

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

Пользовательские поля можно добавлять к звонкам заявкам и сделкам сразу при их создании, в рамках API методов:

• Импорт звонков
  
• Регистрация заявок с сайта
• Импорт заявок
• Создание сделок

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

• Добавление пользовательских полей к лидам
  
• Обновление сделок

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

• Выгрузка журнала звонков
• Выгрузка журнала заявок
• Выгрузка журнала сделок

Можно удалять значения пользовательских полей, добавленных к звонкам, заявкам или сделкам:

• Удаление пользовательских полей из звонков, заявок и сделок

Добавленные по API значения пользовательских полей можно использовать в личном кабинете:

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

2) В журналах звонков, заявок, лидов и сделок, в меню настройки фильтров, будут доступны фильтры по используемым пользовательским полям.

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

• Для числовых пользовательских полей можно выбрать диапазон значений "от" и "до", и отфильтровать звонки, заявки или сделки только со значениями искомого пользовательского поля, которые укладываются в указанный диапазон.

• Для пользовательских полей с датами можно выбрать диапазон дат "от" и "до", и отфильтровать звонки, заявки или сделки только со значениями даты искомого пользовательского поля, которые укладываются в указанный диапазон.
  

Блок с фильтрами по пользовательским полям находится в самом низу полей фильтров, в разделе "Пользовательски поля":

3) В рамках настройки пользовательских метрик с использованием сущностей сделок, можно настроить фильтры по пользовательским полям сделок.