метод REST scope: crm Устаревший

crm.lead.details.configuration.set

Установить параметры карточки

Устаревший метод. Развитие метода остановлено. Используйте crm.item.details.configuration.set.

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

Описание

Метод crm.lead.details.configuration.set устанавливает настройки карточки лидов.

Настройки карточки повторных лидов могут отличаться от настроек карточки простых лидов. Для переключения между настройками карточек лидов применяйте параметр leadCustomerType.

Параметры

data section[] обязательный

Список разделов карточки. Каждый раздел содержит набор полей, которые будут выведены в карточке лида

userId user необязательный

Идентификатор пользователя, для которого нужно сохранить личную конфигурацию.

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

Нужен только при установке личных настроек

scope string необязательный

Область применения настроек. Возможные значения:
- 'P' - личные настройки
- 'C' - общие настройки

По умолчанию используется значение 'P'

extras object необязательный

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

Параметр section

name string обязательный

Уникальное имя раздела

title string обязательный

Заголовок раздела

type string обязательный

Тип раздела. Поддерживается только значение 'section'

elements section_element[] необязательный

Список полей, которые отображаются в разделе

Параметр section_element

name string обязательный

Идентификатор поля лида. Список доступных полей можно получить методом crm.lead.fields

optionFlags integer необязательный

Нужно ли показывать поле всегда:
- 1 - да
- 0 - нет

По умолчанию используется значение 0

options object необязательный

Дополнительные опции поля. Набор опций зависит от типа поля

Параметр extras

leadCustomerType integer необязательный

Тип лида. Возможные значения:
- 1 - простой лид
- 2 - повторный лид

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

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"scope":"P","userId":1,"extras":{"leadCustomerType":2},"data":[{"name":"main","title":"О лиде","type":"section","elements":[{"name":"TITLE"},{"name":"STATUS_ID"},{"name":"SOURCE_ID"},{"name":"NAME"},{"name":"PHONE","optionFlags":1}]},{"name":"additional","title":"Дополнительно","type":"section","elements":[{"name":"ASSIGNED_BY_ID"},{"name":"COMMENTS"}]}]}' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.lead.details.configuration.set

Ответ

HTTP-статус: 200

{
    "result": true,
    "time": {
        "start": 1720728468.828951,
        "finish": 1720728469.214046,
        "duration": 0.38509488105773926,
        "processing": 0.018099069595336914,
        "date_start": "2024-07-11T22:54:28+02:00",
        "date_finish": "2024-07-11T22:54:29+02:00",
        "operating": 0
    }
}

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

result boolean

Корневой элемент ответа. Возвращает true, если настройки успешно сохранены

time time

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

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

HTTP-статус: 400

{
    "error": "",
    "error_description": "Element at index 0 in section at index 1 does not have name."
}
Код Описание Значение
Access denied Недостаточно прав
Parameter 'data' must be array В data передан не массив
The data must be indexed array В data передан не индексированный массив
There are no data to write В data передан пустой массив
Section at index i have type data[i].type. The expected type is 'section' В data[i].type передано значение отличное от 'section'
Section at index i does not have name В data[i].name передано пустое значение
Section at index i does not have title В data[i].title передано пустое значение
Element at index j in section at index i does not have name В data[i].elements[j].name передано пустое значение

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.