Установить параметры карточки crm.lead.details.configuration.set
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод:
- любой пользователь может установить свои настройки,
- пользователь с правом «Разрешить изменять настройки» в CRM может установить чужие и общие настройки
DEPRECATED
Развитие метода остановлено. Используйте crm.item.details.configuration.set.
Метод crm.lead.details.configuration.set устанавливает настройки карточки лидов.
Важно
Настройки карточки повторных лидов могут отличаться от настроек карточки простых лидов. Для переключения между настройками карточек лидов применяйте параметр leadCustomerType.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
data* |
Список разделов карточки. Каждый раздел содержит набор полей, которые будут выведены в карточке лида |
|
userId |
Идентификатор пользователя, для которого нужно сохранить личную конфигурацию. Если параметр не передан, будет использован Нужен только при установке личных настроек |
|
scope |
Область применения настроек. Возможные значения:
По умолчанию используется значение |
|
extras |
Дополнительные параметры для выбора типа лида. Структура описана ниже |
Параметр section
|
Название |
Описание |
|
name* |
Уникальное имя раздела |
|
title* |
Заголовок раздела |
|
type* |
Тип раздела. Поддерживается только значение |
|
elements |
Список полей, которые отображаются в разделе |
Параметр section_element
|
Название |
Описание |
|
name* |
Идентификатор поля лида. Список доступных полей можно получить методом crm.lead.fields |
|
optionFlags |
Нужно ли показывать поле всегда:
По умолчанию используется значение |
|
options |
Дополнительные опции поля. Набор опций зависит от типа поля |
Параметр extras
|
Название |
Описание |
|
leadCustomerType |
Тип лида. Возможные значения:
|
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"scope":"P","userId":1,"extras":{"leadCustomerType":2},"data":[{"name":"main","title":"О лиде","type":"section","elements":[{"name":"TITLE"},{"name":"STATUS_ID"},{"name":"SOURCE_ID"},{"name":"NAME"},{"name":"PHONE","optionFlags":1}]},{"name":"additional","title":"Дополнительно","type":"section","elements":[{"name":"ASSIGNED_BY_ID"},{"name":"COMMENTS"}]}]}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.lead.details.configuration.set
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"scope":"P","userId":1,"extras":{"leadCustomerType":2},"data":[{"name":"main","title":"О лиде","type":"section","elements":[{"name":"TITLE"},{"name":"STATUS_ID"},{"name":"SOURCE_ID"},{"name":"NAME"},{"name":"PHONE","optionFlags":1}]},{"name":"additional","title":"Дополнительно","type":"section","elements":[{"name":"ASSIGNED_BY_ID"},{"name":"COMMENTS"}]}],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.lead.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.lead.details.configuration.set',
params: {
scope: 'P',
userId: 1,
extras: {
leadCustomerType: 2,
},
data: [
{
name: 'main',
title: 'About lead',
type: 'section',
elements: [
{ name: 'TITLE' },
{ name: 'STATUS_ID' },
{ name: 'SOURCE_ID' },
{ name: 'NAME' },
{ name: 'PHONE', optionFlags: 1 },
],
},
{
name: 'additional',
title: 'Additional',
type: 'section',
elements: [
{ 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 setLeadCardConfiguration() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.lead.details.configuration.set',
params: {
scope: 'P',
userId: 1,
extras: {
leadCustomerType: 2,
},
data: [
{
name: 'main',
title: 'About lead',
type: 'section',
elements: [
{ name: 'TITLE' },
{ name: 'STATUS_ID' },
{ name: 'SOURCE_ID' },
{ name: 'NAME' },
{ name: 'PHONE', optionFlags: 1 },
],
},
{
name: 'additional',
title: 'Additional',
type: 'section',
elements: [
{ 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', setLeadCardConfiguration)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.lead.details.configuration.set(
scope="P",
user_id=1,
extras={"leadCustomerType": 2},
).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.lead.details.configuration.set',
[
'scope' => 'P',
'userId' => 1,
'extras' => [
'leadCustomerType' => 2,
],
'data' => [
[
'name' => 'main',
'title' => 'О лиде',
'type' => 'section',
'elements' => [
['name' => 'TITLE'],
['name' => 'STATUS_ID'],
['name' => 'SOURCE_ID'],
['name' => 'NAME'],
['name' => 'PHONE', 'optionFlags' => 1],
],
],
[
'name' => 'additional',
'title' => 'Дополнительно',
'type' => 'section',
'elements' => [
['name' => 'ASSIGNED_BY_ID'],
['name' => 'COMMENTS'],
],
],
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Result: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error: ' . $e->getMessage();
}
BX24.callMethod(
'crm.lead.details.configuration.set',
{
scope: 'P',
userId: 1,
extras: {
leadCustomerType: 2
},
data: [
{
name: 'main',
title: 'О лиде',
type: 'section',
elements: [
{ name: 'TITLE' },
{ name: 'STATUS_ID' },
{ name: 'SOURCE_ID' },
{ name: 'NAME' },
{ name: 'PHONE', optionFlags: 1 }
]
},
{
name: 'additional',
title: 'Дополнительно',
type: 'section',
elements: [
{ name: 'ASSIGNED_BY_ID' },
{ name: 'COMMENTS' }
]
}
]
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'crm.lead.details.configuration.set',
[
'scope' => 'P',
'userId' => 1,
'extras' => [
'leadCustomerType' => 2,
],
'data' => [
[
'name' => 'main',
'title' => 'О лиде',
'type' => 'section',
'elements' => [
['name' => 'TITLE'],
['name' => 'STATUS_ID'],
['name' => 'SOURCE_ID'],
['name' => 'NAME'],
['name' => 'PHONE', 'optionFlags' => 1],
],
],
[
'name' => 'additional',
'title' => 'Дополнительно',
'type' => 'section',
'elements' => [
['name' => 'ASSIGNED_BY_ID'],
['name' => 'COMMENTS'],
],
],
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.lead.details.configuration.set", b24.Params{
"scope": "P",
"userId": 1,
"extras": b24.Params{
"leadCustomerType": 2,
},
"data": []b24.Params{
{
"name": "main",
"title": "О лиде",
"type": "section",
"elements": []b24.Params{
{
"name": "TITLE",
},
{
"name": "STATUS_ID",
},
{
"name": "SOURCE_ID",
},
{
"name": "NAME",
},
{
"name": "PHONE",
"optionFlags": 1,
},
},
},
{
"name": "additional",
"title": "Дополнительно",
"type": "section",
"elements": []b24.Params{
{
"name": "ASSIGNED_BY_ID",
},
{
"name": "COMMENTS",
},
},
},
},
})
if err != nil {
return fmt.Errorf("crm.lead.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": 1720728468.828951,
"finish": 1720728469.214046,
"duration": 0.38509488105773926,
"processing": 0.018099069595336914,
"date_start": "2024-07-11T22:54:28+02:00",
"date_finish": "2024-07-11T22:54:29+02:00",
"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 |
Недостаточно прав |
|
Пустое значение |
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-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |