Сбросить параметры карточки элементов crm.item.details.configuration.reset
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: проверка прав при выполнении метода зависит от переданных данных:
- Любой пользователь имеет право сбросить свои личные настройки
- Пользователь имеет право сбрасывать общие и чужие настройки только если он является администратором
Метод crm.item.details.configuration.reset удаляет сохраненную личную или общую конфигурацию карточки объекта CRM. После сброса личной конфигурации карточка показывается по общей, после сброса общей — по настройкам по умолчанию.
Примечание
- Настройки карточки повторных лидов могут отличаться от настроек карточки простых лидов. Для переключения между настройками карточек лидов применяется параметр
extras.leadCustomerType. - Настройки карточки элемента могут отличаться в зависимости от их воронки. Для переключения используется параметры
extras.categoryId— для смарт-процессовextras.dealCategoryId— для сделок
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
entityTypeId* |
Идентификатор системного или пользовательского типа объектов CRM |
|
userId |
Идентификатор пользователя, чью конфигурацию вы хотите сбросить. Если параметр не передан, то будет взят Нужен только при запросе личных настроек |
|
scope |
Область применения настроек. Допустимые значения:
По умолчанию значение равно |
|
extras |
Дополнительные параметры. Возможные значения и их структура описана ниже |
extras
Параметр в extras зависит от объекта CRM.
|
Объект CRM |
Название |
Описание |
|
Смарт-процесс |
|
Идентификатор воронки смарт-процессов. Можно получить с помощью Если не указано, то берется идентификатор воронки по умолчанию для данного смарт-процесса |
|
Сделка |
|
Идентификатор воронки сделок. Можно получить с помощью Если не указан, то берется идентификатор воронки по умолчанию для сделок |
|
Лид |
|
Тип лидов. Возможные значения:
|
Примеры кода
Как использовать примеры в документации
Сбросить общую конфигурацию карточки сделок в воронке с id = 9
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId":2,"userId":1,"scope":"C","extras":{"dealCategoryId":9}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.item.details.configuration.reset
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId":2,"userId":1,"scope":"C","extras":{"dealCategoryId":9},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.item.details.configuration.reset
// 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.item.details.configuration.reset',
params: {
entityTypeId: 2,
userId: 1,
scope: 'C',
extras: {
dealCategoryId: 9,
},
},
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 reset successfully:', 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 resetDetailsConfiguration() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.item.details.configuration.reset',
params: {
entityTypeId: 2,
userId: 1,
scope: 'C',
extras: {
dealCategoryId: 9,
},
},
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 reset successfully:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', resetDetailsConfiguration)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.item.details.configuration.reset(
entity_type_id=2,
user_id=1,
scope="C",
extras={
"dealCategoryId": 9,
},
).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.item.details.configuration.reset',
[
'entityTypeId' => 2,
'userId' => 1,
'scope' => "C",
'extras' => [
'dealCategoryId' => 9,
],
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
'crm.item.details.configuration.reset',
{
entityTypeId: 2,
userId: 1,
scope: "C",
extras: {
dealCategoryId: 9,
},
},
(result) => {
if (result.error())
{
console.error(result.error());
return;
}
console.info(result.data());
},
);
require_once('crest.php');
$result = CRest::call(
'crm.item.details.configuration.reset',
[
'entityTypeId' => 2,
'userId' => 1,
'scope' => 'C',
'extras' => [
'dealCategoryId' => 9,
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.item.details.configuration.reset", b24.Params{
"entityTypeId": 2,
"userId": 1,
"scope": "C",
"extras": b24.Params{
"dealCategoryId": 9,
},
})
if err != nil {
return fmt.Errorf("crm.item.details.configuration.reset: %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": 1720687072.190654,
"finish": 1720687072.586945,
"duration": 0.39629101753234863,
"processing": 0.057084083557128906,
"date_start": "2024-07-11T10:37:52+02:00",
"date_finish": "2024-07-11T10:37:52+02:00",
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа. Возвращает Метод возвращает |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "Parameter 'entityTypeID' is not defined"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
Пустое значение |
Parameter 'entityTypeID' is not defined |
Не передан обязательный параметр |
|
|
Пустое значение |
The entity type ' |
Тип объекта CRM не поддерживает настройку карточки, например |
|
|
Пустое значение |
Access denied. |
Сбрасываются общие настройки или личные настройки другого пользователя, а у пользователя нет прав администратора |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |