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

crm.lead.details.configuration.get

Получить параметры карточки

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

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

Описание

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

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

Параметры

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

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

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

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

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

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

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

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

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

Параметр extras

lead.customer.type integer необязательный

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

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"scope":"P","userId":1}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.lead.details.configuration.get

Ответ

HTTP-статус: 200

{
    "result": [
        {
            "name": "main",
            "title": "О лиде",
            "type": "section",
            "elements": [
                {
                    "name": "TITLE",
                    "optionFlags": "0"
                },
                {
                    "name": "STATUS_ID",
                    "optionFlags": "0"
                },
                {
                    "name": "SOURCE_ID",
                    "optionFlags": "0"
                }
            ]
        },
        {
            "name": "additional",
            "title": "Дополнительно",
            "type": "section",
            "elements": [
                {
                    "name": "ASSIGNED_BY_ID",
                    "optionFlags": "0"
                },
                {
                    "name": "COMMENTS",
                    "optionFlags": "0"
                }
            ]
        }
    ],
    "time": {
        "start": 1720624891.017344,
        "finish": 1720624891.405621,
        "duration": 0.3882770538330078,
        "processing": 0.02097320556640625,
        "date_start": "2024-07-10T17:21:31+02:00",
        "date_finish": "2024-07-10T17:21:31+02:00",
        "operating": 0
    }
}

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

result section[]

Корневой элемент ответа. Содержит конфигурацию разделов карточки лида. Возвращает null, если конфигурация не найдена

time time

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

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

HTTP-статус: 400

{
    "error": "",
    "error_description": "Access denied."
}
Код Описание Значение
Access denied Недостаточно прав для получения запрошенной конфигурации

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

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