Установить параметры карточки crm.company.details.configuration.set
Scope:
crmКто может выполнять метод:
- любой пользователь может установить свои настройки,
- пользователь с правом «Разрешить изменять настройки» в CRM может установить чужие и общие настройки
DEPRECATED
Развитие метода остановлено. Используйте crm.item.details.configuration.set.
Метод crm.company.details.configuration.set устанавливает настройки карточки компаний: записывает личные настройки карточки указанного пользователя или общие настройки для всех пользователей.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
scope |
Область применения настроек. Возможные значения:
По умолчанию — |
|
userId |
Идентификатор пользователя, получить можно методом user.get. Нужен только при установке личных настроек. Если не задан — берется |
|
data* |
Список Структура описана ниже |
section
Описывает отдельно взятый раздел с полями внутри карточки компании.
Обязательные параметры отмечены *
|
Название |
Описание |
|
name* |
Уникальное название раздела |
|
title* |
Название раздела. Отображается в карточке элемента |
|
type* |
Тип раздела. На данный момент доступно только значение |
|
elements |
Массив Структура описана ниже |
section_element
Конфигурация отдельно взятого поля внутри раздела.
Обязательные параметры отмечены *
|
Название |
Описание |
|
name* |
Идентификатор поля. Список доступных полей можно узнать с помощью |
|
optionFlags |
Нужно ли показывать поле всегда:
По умолчанию — |
|
options |
Дополнительный список опций для поля |
section_element.options
|
Название |
Поля, где доступна опция |
Описание |
|
defaultAddressType |
|
Идентификатор типа адреса по умолчанию. Чтобы узнать возможные типы адресов, используйте |
|
defaultCountry |
|
Код страны для формата телефонного номера по умолчанию — строка из двух латинских букв. Например |
Примеры кода
Как использовать примеры в документации
Для пользователя с id = 1 в компаниях установить конфигурацию карточки:
- Раздел 1 — О компании
- Название
- Логотип
- Тип компании
- Должность
- Телефон
- Страна по умолчанию: Россия(+7)
- Контакт
- Раздел 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
try
{
const response = await $b24.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" }
]
}
]
}
);
const result = response.getData().result;
if(result.error())
console.error(result.error());
else
console.dir(result);
}
catch(error)
{
console.error(error);
}
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 |
Корневой элемент ответа, содержит |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "Element at index 0 in section at index 1 does not have name."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
Access denied |
У пользователя нет прав изменять настройки CRM |
|
|
Parameter 'data' must be array |
В |
|
|
The data must be indexed array |
В |
|
|
There are no data to write |
В |
|
|
Section at index |
В |
|
|
Section at index |
В |
|
|
Section at index |
В |
|
|
Element at index |
В |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Управление карточками компаний: обзор методов
- Получить параметры карточки crm.company.details.configuration.get
- Установить общую карточку для всех пользователей crm.company.details.configuration.forceCommonScopeForAll
- Сбросить параметры карточки crm.company.details.configuration.reset