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

Scope: crm

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

пользователь может устанавливать свои личные настройки

установить личные настройки другого пользователя можно при наличии прав на редактирование персонального вида для пользователя

установить общие настройки можно при наличии прав на редактирование общего вида

DEPRECATED

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

Метод crm.deal.details.configuration.set устанавливает настройки карточки сделки. Метод записывает личные настройки карточки указанного пользователя или общие настройки для всех пользователей.

Примечание

Настройки карточки сделок в разных воронках могут отличаться. Для выбора воронки используйте параметр extras.dealCategoryId.

Параметры метода

Обязательные параметры отмечены *

Название `тип`	Описание
scope `string`	Область применения настроек. Возможные значения: `P` — личные настройки `C` — общие настройки По умолчанию — `P`
userId `user`	Идентификатор пользователя. Нужен только при установке личных настроек другого пользователя. Если не задан, берется текущий
data* `section[]`	Список `section`, описывающий конфигурацию разделов карточки сделки. Структура `section` описана ниже
extras `object`	Дополнительные параметры (подробное описание)

Параметр extras

Обязательные параметры отмечены *

Название
тип

Описание

dealCategoryId
integer

Идентификатор воронки сделок. Можно получить с помощью crm.category.list

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

Параметр section

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

Обязательные параметры отмечены *

Название `тип`	Описание
name* `string`	Уникальное название раздела
title* `string`	Название раздела
type* `string`	Тип раздела На данный момент доступно только значение `section`
elements `section_element[]`	Список выводимых в карточке полей с дополнительными настройками

Параметр section_element

Конфигурация отдельного поля внутри раздела

Обязательные параметры отмечены *

Название `тип`	Описание
name* `string`	Идентификатор поля. Список доступных полей можно узнать с помощью `crm.deal.fields`
optionFlags `integer`	Нужно ли показывать поле всегда: `1` — да `0` — нет По умолчанию — `0`
options `object`	Дополнительные опции поля. Состав зависит от поля

Примеры кода

Как использовать примеры в документации

Установить личную конфигурацию карточки сделки для пользователя с id = 1 в воронке с id = 32

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"scope":"P","userId":1,"extras":{"dealCategoryId":32},"data":[{"name":"main","title":"О сделке","type":"section","elements":[{"name":"TITLE"},{"name":"OPPORTUNITY_WITH_CURRENCY"},{"name":"STAGE_ID"},{"name":"CLOSEDATE"},{"name":"CLIENT"}]},{"name":"additional","title":"Дополнительно","type":"section","elements":[{"name":"TYPE_ID"},{"name":"SOURCE_ID"},{"name":"SOURCE_DESCRIPTION"},{"name":"OPENED"},{"name":"ASSIGNED_BY_ID"},{"name":"COMMENTS"}]},{"name":"products","title":"Товары","type":"section","elements":[{"name":"PRODUCT_ROW_SUMMARY"}]}]}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.deal.details.configuration.set

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"scope":"P","userId":1,"extras":{"dealCategoryId":32},"data":[{"name":"main","title":"О сделке","type":"section","elements":[{"name":"TITLE"},{"name":"OPPORTUNITY_WITH_CURRENCY"},{"name":"STAGE_ID"},{"name":"CLOSEDATE"},{"name":"CLIENT"}]},{"name":"additional","title":"Дополнительно","type":"section","elements":[{"name":"TYPE_ID"},{"name":"SOURCE_ID"},{"name":"SOURCE_DESCRIPTION"},{"name":"OPENED"},{"name":"ASSIGNED_BY_ID"},{"name":"COMMENTS"}]},{"name":"products","title":"Товары","type":"section","elements":[{"name":"PRODUCT_ROW_SUMMARY"}]}],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.deal.details.configuration.set

try
        {
        	const response = await $b24.callMethod(
        		'crm.deal.details.configuration.set',
        		{
        			scope: "P",
        			userId: 1,
        			extras: {
        				dealCategoryId: 32,
        			},
        			data: [
        				{
        					name: "main",
        					title: "О сделке",
        					type: "section",
        					elements: [
        						{ name: "TITLE" },
        						{ name: "OPPORTUNITY_WITH_CURRENCY" },
        						{ name: "STAGE_ID" },
        						{ name: "CLOSEDATE" },
        						{ name: "CLIENT" },
        					],
        				},
        				{
        					name: "additional",
        					title: "Дополнительно",
        					type: "section",
        					elements: [
        						{ name: "TYPE_ID" },
        						{ name: "SOURCE_ID" },
        						{ name: "SOURCE_DESCRIPTION" },
        						{ name: "OPENED" },
        						{ name: "ASSIGNED_BY_ID" },
        						{ name: "COMMENTS" },
        					],
        				},
        				{
        					name: "products",
        					title: "Товары",
        					type: "section",
        					elements: [
        						{ name: "PRODUCT_ROW_SUMMARY" },
        					],
        				},
        			],
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.deal.details.configuration.set',
                    [
                        'scope'  => 'P',
                        'userId' => 1,
                        'extras' => [
                            'dealCategoryId' => 32,
                        ],
                        'data' => [
                            [
                                'name'     => 'main',
                                'title'    => 'О сделке',
                                'type'     => 'section',
                                'elements' => [
                                    ['name' => 'TITLE'],
                                    ['name' => 'OPPORTUNITY_WITH_CURRENCY'],
                                    ['name' => 'STAGE_ID'],
                                    ['name' => 'CLOSEDATE'],
                                    ['name' => 'CLIENT'],
                                ],
                            ],
                            [
                                'name'     => 'additional',
                                'title'    => 'Дополнительно',
                                'type'     => 'section',
                                'elements' => [
                                    ['name' => 'TYPE_ID'],
                                    ['name' => 'SOURCE_ID'],
                                    ['name' => 'SOURCE_DESCRIPTION'],
                                    ['name' => 'OPENED'],
                                    ['name' => 'ASSIGNED_BY_ID'],
                                    ['name' => 'COMMENTS'],
                                ],
                            ],
                            [
                                'name'     => 'products',
                                'title'    => 'Товары',
                                'type'     => 'section',
                                'elements' => [
                                    ['name' => 'PRODUCT_ROW_SUMMARY'],
                                ],
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                echo 'Error: ' . $result->error();
            } else {
                echo 'Data: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error setting deal details configuration: ' . $e->getMessage();
        }

BX24.callMethod(
            'crm.deal.details.configuration.set',
            {
                scope: "P",
                userId: 1,
                extras: {
                    dealCategoryId: 32,
                },
                data: [
                    {
                        name: "main",
                        title: "О сделке",
                        type: "section",
                        elements: [
                            { name: "TITLE" },
                            { name: "OPPORTUNITY_WITH_CURRENCY" },
                            { name: "STAGE_ID" },
                            { name: "CLOSEDATE" },
                            { name: "CLIENT" },
                        ],
                    },
                    {
                        name: "additional",
                        title: "Дополнительно",
                        type: "section",
                        elements: [
                            { name: "TYPE_ID" },
                            { name: "SOURCE_ID" },
                            { name: "SOURCE_DESCRIPTION" },
                            { name: "OPENED" },
                            { name: "ASSIGNED_BY_ID" },
                            { name: "COMMENTS" },
                        ],
                    },
                    {
                        name: "products",
                        title: "Товары",
                        type: "section",
                        elements: [
                            { name: "PRODUCT_ROW_SUMMARY" },
                        ],
                    },
                ],
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.deal.details.configuration.set',
            [
                'scope' => 'P',
                'userId' => 1,
                'extras' => [
                    'dealCategoryId' => 32,
                ],
                'data' => [
                    [
                        'name' => 'main',
                        'title' => 'О сделке',
                        'type' => 'section',
                        'elements' => [
                            ['name' => 'TITLE'],
                            ['name' => 'OPPORTUNITY_WITH_CURRENCY'],
                            ['name' => 'STAGE_ID'],
                            ['name' => 'CLOSEDATE'],
                            ['name' => 'CLIENT'],
                        ],
                    ],
                    [
                        'name' => 'additional',
                        'title' => 'Дополнительно',
                        'type' => 'section',
                        'elements' => [
                            ['name' => 'TYPE_ID'],
                            ['name' => 'SOURCE_ID'],
                            ['name' => 'SOURCE_DESCRIPTION'],
                            ['name' => 'OPENED'],
                            ['name' => 'ASSIGNED_BY_ID'],
                            ['name' => 'COMMENTS'],
                        ],
                    ],
                    [
                        'name' => 'products',
                        'title' => 'Товары',
                        'type' => 'section',
                        'elements' => [
                            ['name' => 'PRODUCT_ROW_SUMMARY'],
                        ],
                    ],
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": true,
            "time": {
                "start": 1773311825,
                "finish": 1773311825.969825,
                "duration": 0.969825029373169,
                "processing": 0,
                "date_start": "2026-03-12T13:37:05+03:00",
                "date_finish": "2026-03-12T13:37:05+03:00",
                "operating_reset_at": 1773312425,
                "operating": 0
            }
        }

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

Название `тип`	Описание
result `boolean`	Корневой элемент ответа. Возвращает `true` в случае успешной записи настроек
time `time`	Информация о времени выполнения запроса

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

HTTP-статус: 400

{
            "error": "",
            "error_description": "Access denied."
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Статус	Код	Описание	Значение
`400`	Пустое значение	Access denied	Нет прав на установку настроек карточки сделки
`400`	Пустое значение	Parameter 'data' must be array	В `data` передан не массив
`400`	Пустое значение	There are no data to write	В `data` передан пустой массив
`400`	Пустое значение	The data must be indexed array	В `data` передан не индексированный массив
`400`	Пустое значение	Section at index `i` have type `data[i].type`. The expected type is 'section'	В `data[i].type` находится значение, отличное от `section`
`400`	Пустое значение	Section at index `i` does not have name	В `data[i].name` передано пустое значение
`400`	Пустое значение	Section at index `i` does not have title	В `data[i].title` передано пустое значение
`400`	Пустое значение	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	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

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

Сбросить параметры карточки сделки

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

Параметры методаПараметры метода

Параметр extrasПараметр extras

Параметр sectionПараметр section

Параметр section_elementПараметр section_element

Примеры кодаПримеры кода

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

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

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

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

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

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

Параметры метода

Параметр extras

Параметр section

Параметр section_element

Примеры кода

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

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

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

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

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

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