Установить параметры карточки сделки 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
string

Область применения настроек.

Возможные значения:

  • P — личные настройки
  • C — общие настройки

По умолчанию — P

userId
user

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

Если не задан, берется текущий

data*
section[]

Список разделов карточки сделки (подробное описание). Разделы и поля, которых нет в data, из карточки пропадут

extras
object

Дополнительные параметры (подробное описание)

Параметр extras

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

Название
тип

Описание

dealCategoryId
integer

Идентификатор воронки сделок. Можно получить методом crm.category.list с entityTypeId = 2 или crm.deal.category.list в REST 3.0 — идентификаторы совпадают

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

Параметр section

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

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

Название
тип

Описание

name*
string

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

title*
string

Название раздела

type*
string

Тип раздела

Всегда section

elements
section_element[]

Список выводимых в карточке полей с дополнительными настройками

Параметр section_element

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

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

Название
тип

Описание

name*
string

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

optionFlags
integer|string

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

  • 1 — да
  • 0 — нет

Можно передать и строкой "1" или "0". Нечисловое значение метод не сохраняет и ошибку не возвращает.

Если не передан, признак не сохраняется и поле ведет себя как при 0. В ответе crm.deal.details.configuration.get у такого поля нет optionFlags

options
object

Дополнительные опции поля. Состав зависит от поля, например у CLIENT — defaultCountry, у OPPORTUNITY_WITH_CURRENCY — isPayButtonVisible и isPaymentDocumentsVisible. Если передать не объект, опции не сохранятся, ошибки не будет

Примеры кода

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

Установить личную конфигурацию карточки сделки для пользователя с 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
boolean

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

time
time

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

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

HTTP-статус: 400

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

Название
тип

Описание

error
string

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

error_description
string

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

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

Статус

Код

Описание

Значение

400

Пустое значение

Access denied.

Передан scope = P и userId другого пользователя, а текущий пользователь не администратор CRM

400

Пустое значение

Access denied.

Передан scope = C, а у пользователя нет прав на редактирование общего вида карточки сделки в воронке extras.dealCategoryId

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-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

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

Описание

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

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

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

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

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

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

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

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

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