crm.lead.details.configuration.reset
Сбросить параметры карточки
Описание
Метод crm.lead.details.configuration.reset сбрасывает настройки карточки лидов.
Настройки карточки повторных лидов могут отличаться от настроек карточки простых лидов. Для переключения между настройками карточек лидов используйте параметр lead.customer.type в extras.
Параметры
userId
user
необязательный
Идентификатор пользователя, для которого нужно сбросить личную конфигурацию.
Если параметр не передан, будет использован userId пользователя, который вызывает метод.
Нужен только при сбросе личных настроек
scope
string
необязательный
Область применения настроек. Возможные значения:
- 'P' - личные настройки
- 'C' - общие настройки
По умолчанию используется значение 'P'
extras
object
необязательный
Дополнительные параметры для выбора типа лида. Структура описана ниже
Параметр extras
lead.customer.type
integer
необязательный
Тип лида. Возможные значения:
- 1 - простой лид
- 2 - повторный лид
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"scope":"P","userId":1}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.lead.details.configuration.reset
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"scope":"P","userId":1,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.lead.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.lead.details.configuration.reset',
params: {
scope: 'P',
userId: 1,
},
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:', 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 resetLeadCardConfiguration() {
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.reset',
params: {
scope: 'P',
userId: 1,
},
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:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', resetLeadCardConfiguration)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.lead.details.configuration.reset(
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.reset',
[
'scope' => 'P',
'userId' => 1,
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error resetting lead details configuration: ' . $e->getMessage();
}
BX24.callMethod(
"crm.lead.details.configuration.reset",
{
scope: "P",
userId: 1
},
function(result)
{
if(result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.lead.details.configuration.reset',
[
'scope' => 'P',
'userId' => 1
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.lead.details.configuration.reset", b24.Params{
"scope": "P",
"userId": 1,
})
if err != nil {
return fmt.Errorf("crm.lead.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
boolean
Корневой элемент ответа. Возвращает true, если настройки успешно сброшены
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "Access denied."
}
| Код | Описание | Значение |
|---|---|---|
| — | Access denied | Недостаточно прав для сброса запрошенной конфигурации |

