Установить параметры карточки crm.lead.details.configuration.set

Scope: crm

Кто может выполнять метод:

  • любой пользователь может установить свои настройки,
  • пользователь с правом «Разрешить изменять настройки» в CRM может установить чужие и общие настройки

DEPRECATED

Развитие метода остановлено. Используйте 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
        
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"}]}],"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/crm.lead.details.configuration.set
        
try
        {
            const response = await $b24.callMethod(
                'crm.lead.details.configuration.set',
                {
                    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' },
                            ],
                        },
                    ],
                }
            );
        
            const result = response.getData().result;
            console.info(result);
        }
        catch (error)
        {
            console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.lead.details.configuration.set',
                    [
                        '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'],
                                ],
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Result: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'crm.lead.details.configuration.set',
            {
                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' }
                        ]
                    }
                ]
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.lead.details.configuration.set',
            [
                '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'],
                        ],
                    ],
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

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."
        }

Название
тип

Описание

error
string

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

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код

Описание

Значение

-

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 передано пустое значение

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

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

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

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

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

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

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

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

Предыдущая
Сбросить параметры карточки
Следующая
Установить общую карточку для всех пользователей