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

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: crm

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

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

DEPRECATED

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

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

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

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

Название
тип

Описание

scope
string

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

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

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

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

userId
user

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

Если не задан — берется id текущего пользователя

data*
section[]

Список section описывает конфигурацию разделов полей в карточке компании.

Структура описана ниже

section

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

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

Название
тип

Описание

name*
string

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

title*
string

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

Отображается в карточке элемента

type*
string

Тип раздела.

На данный момент доступно только значение 'section'

elements
section_element[]

Массив section_element описывает конфигурацию полей в разделе.

Структура описана ниже

section_element

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

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

Название
тип

Описание

name*
string

Идентификатор поля.

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

optionFlags
integer

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

  • 1 — да
  • 0 — нет

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

options
object

Дополнительный список опций для поля

section_element.options

Название
тип

Поля, где доступна опция

Описание

defaultAddressType
integer

ADDRESS

Идентификатор типа адреса по умолчанию. Чтобы узнать возможные типы адресов, используйте crm.enum.addresstype

defaultCountry
string

PHONE
CLIENT
COMPANY
CONTACT
MYCOMPANY_ID

Код страны для формата телефонного номера по умолчанию — строка из двух латинских букв.

Например "RU"

Примеры кода

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

Для пользователя с id = 1 в компаниях установить конфигурацию карточки:

  • Раздел 1 — О компании
    • Название
    • Логотип
    • Тип компании
    • Должность
    • Телефон
      • Страна по умолчанию: Россия(+7)
    • E-mail
    • Контакт
  • Раздел 2 — Дополнительно
    • Сфера деятельности
    • Доступна ли компания для всех
    • Ответственный**
    • Комментарий
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"userId":1,"data":[{"name":"main","title":"О компании","type":"section","elements":[{"name":"TITLE"},{"name":"LOGO"},{"name":"COMPANY_TYPE"},{"name":"POST"},{"name":"PHONE","options":{"defaultCountry":"RU"}},{"name":"EMAIL"},{"name":"CONTACT"}]},{"name":"additional","title":"Дополнительно","type":"section","elements":[{"name":"INDUSTRY"},{"name":"OPENED"},{"name":"ASSIGNED_BY_ID"},{"name":"COMMENTS"}]}]}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.company.details.configuration.set
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"userId":1,"data":[{"name":"main","title":"О компании","type":"section","elements":[{"name":"TITLE"},{"name":"LOGO"},{"name":"COMPANY_TYPE"},{"name":"POST"},{"name":"PHONE","options":{"defaultCountry":"RU"}},{"name":"EMAIL"},{"name":"CONTACT"}]},{"name":"additional","title":"Дополнительно","type":"section","elements":[{"name":"INDUSTRY"},{"name":"OPENED"},{"name":"ASSIGNED_BY_ID"},{"name":"COMMENTS"}]}],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.company.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.company.details.configuration.set',
            params: {
              userId: 1,
              data: [
                {
                  name: 'main',
                  title: 'About company',
                  type: 'section',
                  elements: [
                    { name: 'TITLE' },
                    { name: 'LOGO' },
                    { name: 'COMPANY_TYPE' },
                    { name: 'POST' },
                    {
                      name: 'PHONE',
                      options: {
                        defaultCountry: 'RU',
                      },
                    },
                    { name: 'EMAIL' },
                    { name: 'CONTACT' },
                  ],
                },
                {
                  name: 'additional',
                  title: 'Additional',
                  type: 'section',
                  elements: [
                    { name: 'INDUSTRY' },
                    { name: 'OPENED' },
                    { name: 'ASSIGNED_BY_ID' },
                    { name: 'COMMENTS' },
                  ],
                },
              ],
            },
            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 setCompanyDetailsConfiguration() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.company.details.configuration.set',
                params: {
                  userId: 1,
                  data: [
                    {
                      name: 'main',
                      title: 'About company',
                      type: 'section',
                      elements: [
                        { name: 'TITLE' },
                        { name: 'LOGO' },
                        { name: 'COMPANY_TYPE' },
                        { name: 'POST' },
                        {
                          name: 'PHONE',
                          options: {
                            defaultCountry: 'RU',
                          },
                        },
                        { name: 'EMAIL' },
                        { name: 'CONTACT' },
                      ],
                    },
                    {
                      name: 'additional',
                      title: 'Additional',
                      type: 'section',
                      elements: [
                        { name: 'INDUSTRY' },
                        { name: 'OPENED' },
                        { name: 'ASSIGNED_BY_ID' },
                        { name: 'COMMENTS' },
                      ],
                    },
                  ],
                },
                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', setCompanyDetailsConfiguration)
        </script>
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.company.details.configuration.set',
                    [
                        'userId' => 1,
                        'data' => [
                            [
                                'name' => 'main',
                                'title' => 'О компании',
                                'type' => 'section',
                                'elements' => [
                                    ['name' => 'TITLE'],
                                    ['name' => 'LOGO'],
                                    ['name' => 'COMPANY_TYPE'],
                                    ['name' => 'POST'],
                                    [
                                        'name' => 'PHONE',
                                        'options' => [
                                            'defaultCountry' => 'RU',
                                        ],
                                    ],
                                    ['name' => 'EMAIL'],
                                    ['name' => 'CONTACT']
                                ]
                            ],
                            [
                                'name' => 'additional',
                                'title' => 'Дополнительно',
                                'type' => 'section',
                                'elements' => [
                                    ['name' => 'INDUSTRY'],
                                    ['name' => 'OPENED'],
                                    ['name' => 'ASSIGNED_BY_ID'],
                                    ['name' => 'COMMENTS']
                                ]
                            ]
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error setting company details configuration: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "crm.company.details.configuration.set",
            {
                userId: 1,
                data:
                [
                    {
                        name: "main",
                        title: "О компании",
                        type: "section",
                        elements:
                        [
                            { name: "TITLE" },
                            { name: "LOGO" },
                            { name: "COMPANY_TYPE" },
                            { name: "POST" },
                            {
                                name: "PHONE",
                                options: {
                                    defaultCountry: "RU",
                                },
                            },
                            { name: "EMAIL" },
                            { name: "CONTACT" }
                        ]
                    },
                    {
                        name: "additional",
                        title: "Дополнительно",
                        type: "section",
                        elements:
                        [
                            { name: "INDUSTRY" },
                            { name: "OPENED" },
                            { name: "ASSIGNED_BY_ID" },
                            { name: "COMMENTS" }
                        ]
                    }
                ]
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.company.details.configuration.set',
            [
                'userId' => 1,
                'data' => [
                    [
                        'name' => 'main',
                        'title' => 'О компании',
                        'type' => 'section',
                        'elements' => [
                            ['name' => 'TITLE'],
                            ['name' => 'LOGO'],
                            ['name' => 'COMPANY_TYPE'],
                            ['name' => 'POST'],
                            [
                                'name' => 'PHONE',
                                'options' => [
                                    'defaultCountry' => 'RU',
                                ],
                            ],
                            ['name' => 'EMAIL'],
                            ['name' => 'CONTACT'],
                        ]
                    ],
                    [
                        'name' => 'additional',
                        'title' => 'Дополнительно',
                        'type' => 'section',
                        'elements' => [
                            ['name' => 'INDUSTRY'],
                            ['name' => 'OPENED'],
                            ['name' => 'ASSIGNED_BY_ID'],
                            ['name' => 'COMMENTS'],
                        ]
                    ],
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

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

HTTP-статус: 200

{
            "result": true,
            "time": {
                "start": 1769419970,
                "finish": 1769419970.57774,
                "duration": 0.577739953994751,
                "processing": 0,
                "date_start": "2026-01-26T12:32:50+03:00",
                "date_finish": "2026-01-26T12:32:50+03:00",
                "operating_reset_at": 1769420570,
                "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

У пользователя нет прав изменять настройки CRM

-

Parameter 'data' must be array

В data передан не массив

-

The data must be indexed array

В data передан не индексированный массив

-

There are no data to write

В data передан пустой массив

-

Section at index # have type data[i].type. The expected type is 'section'

В data[i].type находится значение отличное от 'section'

-

Section at index # does not have name

В data[i].name передано пустое значение

-

Section at index # does not have title

В data[i].title передано пустое значение

-

Element at index # in section at index # 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

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

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

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

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

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

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