Установить параметры карточки сделки crm.deal.details.configuration.set
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод:
- пользователь — свои личные настройки
- администратор CRM — личные настройки другого пользователя
- пользователь с правом редактировать общий вид карточки сделки — общие настройки
DEPRECATED
Развитие метода остановлено. Используйте метод REST 3.0 crm.deal.detailpagelayout.update.
Метод crm.deal.details.configuration.set записывает личные настройки карточки сделки указанного пользователя или общие настройки для всех пользователей.
Примечание
Настройки карточки сделок в разных воронках могут отличаться. Для выбора воронки используйте параметр extras.dealCategoryId.
Метод не дополняет текущие настройки, а заменяет их. Чтобы изменить один раздел или поле, сначала получите текущую структуру методом crm.deal.details.configuration.get, измените ее и передайте целиком.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
scope |
Область применения настроек. Возможные значения:
По умолчанию — |
|
userId |
Идентификатор пользователя. Нужен только при установке личных настроек другого пользователя. Если не задан, берется текущий |
|
data* |
Список разделов карточки сделки (подробное описание). Разделы и поля, которых нет в |
|
extras |
Дополнительные параметры (подробное описание) |
Параметр extras
Обязательные параметры отмечены *
|
Название |
Описание |
|
dealCategoryId |
Идентификатор воронки сделок. Можно получить методом crm.category.list с Если не указан, используется воронка по умолчанию для сделок |
Параметр section
Описывает отдельный раздел с полями внутри карточки сделки
Обязательные параметры отмечены *
|
Название |
Описание |
|
name* |
Уникальное название раздела |
|
title* |
Название раздела |
|
type* |
Тип раздела Всегда |
|
elements |
Список выводимых в карточке полей с дополнительными настройками |
Параметр section_element
Конфигурация отдельного поля внутри раздела
Обязательные параметры отмечены *
|
Название |
Описание |
|
name* |
Идентификатор поля. Список доступных полей можно узнать с помощью |
|
optionFlags |
Нужно ли показывать поле всегда:
Можно передать и строкой Если не передан, признак не сохраняется и поле ведет себя как при |
|
options |
Дополнительные опции поля. Состав зависит от поля, например у |
Примеры кода
Как использовать примеры в документации
Установить личную конфигурацию карточки сделки для пользователя с id = 1 в воронке с id = 32
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
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
try {
const response = await $b24.actions.v2.call.make<boolean>({
method: 'crm.deal.details.configuration.set',
params: {
scope: 'P',
userId: 1,
extras: {
dealCategoryId: 32,
},
data: [
{
name: 'main',
title: 'About the deal',
type: 'section',
elements: [
{ name: 'TITLE' },
{ name: 'OPPORTUNITY_WITH_CURRENCY' },
{ name: 'STAGE_ID' },
{ name: 'CLOSEDATE' },
{ name: 'CLIENT' },
],
},
{
name: 'additional',
title: 'Additional',
type: 'section',
elements: [
{ name: 'TYPE_ID' },
{ name: 'SOURCE_ID' },
{ name: 'SOURCE_DESCRIPTION' },
{ name: 'OPENED' },
{ name: 'ASSIGNED_BY_ID' },
{ name: 'COMMENTS' },
],
},
{
name: 'products',
title: 'Products',
type: 'section',
elements: [
{ name: 'PRODUCT_ROW_SUMMARY' },
],
},
],
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Configuration saved:', result)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function setDealCardConfiguration() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.deal.details.configuration.set',
params: {
scope: 'P',
userId: 1,
extras: {
dealCategoryId: 32,
},
data: [
{
name: 'main',
title: 'About the deal',
type: 'section',
elements: [
{ name: 'TITLE' },
{ name: 'OPPORTUNITY_WITH_CURRENCY' },
{ name: 'STAGE_ID' },
{ name: 'CLOSEDATE' },
{ name: 'CLIENT' },
],
},
{
name: 'additional',
title: 'Additional',
type: 'section',
elements: [
{ name: 'TYPE_ID' },
{ name: 'SOURCE_ID' },
{ name: 'SOURCE_DESCRIPTION' },
{ name: 'OPENED' },
{ name: 'ASSIGNED_BY_ID' },
{ name: 'COMMENTS' },
],
},
{
name: 'products',
title: 'Products',
type: 'section',
elements: [
{ name: 'PRODUCT_ROW_SUMMARY' },
],
},
],
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Configuration saved:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', setDealCardConfiguration)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.deal.details.configuration.set(
scope="P",
user_id=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"},
],
},
],
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.deal.details.configuration.set", b24.Params{
"scope": "P",
"userId": 1,
"extras": b24.Params{
"dealCategoryId": 32,
},
"data": []b24.Params{
{
"name": "main",
"title": "О сделке",
"type": "section",
"elements": []b24.Params{
{
"name": "TITLE",
},
{
"name": "OPPORTUNITY_WITH_CURRENCY",
},
{
"name": "STAGE_ID",
},
{
"name": "CLOSEDATE",
},
{
"name": "CLIENT",
},
},
},
{
"name": "additional",
"title": "Дополнительно",
"type": "section",
"elements": []b24.Params{
{
"name": "TYPE_ID",
},
{
"name": "SOURCE_ID",
},
{
"name": "SOURCE_DESCRIPTION",
},
{
"name": "OPENED",
},
{
"name": "ASSIGNED_BY_ID",
},
{
"name": "COMMENTS",
},
},
},
{
"name": "products",
"title": "Товары",
"type": "section",
"elements": []b24.Params{
{
"name": "PRODUCT_ROW_SUMMARY",
},
},
},
},
})
if err != nil {
return fmt.Errorf("crm.deal.details.configuration.set: %w", err)
}
var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)
Обработка ответа
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 |
Корневой элемент ответа. Возвращает |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "Access denied."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
Пустое значение |
Access denied. |
Передан |
|
|
Пустое значение |
Access denied. |
Передан |
|
|
Пустое значение |
Parameter 'data' must be array |
В |
|
|
Пустое значение |
There are no data to write |
В |
|
|
Пустое значение |
The data must be indexed array |
В |
|
|
Пустое значение |
Section at index |
В |
|
|
Пустое значение |
Section at index |
В |
|
|
Пустое значение |
Section at index |
В |
|
|
Пустое значение |
Element at index |
В |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |