crm.category.delete
Удалить воронку
Описание
Метод удаляет воронку (направление) с идентификатором id.
Не получится удалить:
- Воронки по умолчанию
- Воронки у которых есть хотя бы один элемент
Параметры
entityTypeId
integer
обязательный
Идентификатор системного или пользовательского типа сущности CRM у которой будет удалена воронка
id
integer
обязательный
Идентификатор удаляемой воронки. Можно получить методом crm.category.list или при создании воронки методом crm.category.add
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId":2,"id":5}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.category.delete
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId":2,"id":5,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.category.delete
// 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<null>({
method: 'crm.category.delete',
params: {
entityTypeId: 2,
id: 5,
},
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('Category deleted 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 deleteCategory() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.category.delete',
params: {
entityTypeId: 2,
id: 5,
},
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('Category deleted successfully', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', deleteCategory)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.category.delete(
bitrix_id=5,
entity_type_id=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.category.delete',
[
'entityTypeId' => 2,
'id' => 5,
]
);
$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 deleting category: ' . $e->getMessage();
}
BX24.callMethod(
"crm.category.delete",
{
entityTypeId: 2,
id: 5,
},
(result) =>
{
if (result.error())
{
console.error(result.error());
}
else
{
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'crm.category.delete',
[
'entityTypeId' => 2,
'id' => 5
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.category.delete", b24.Params{
"entityTypeId": 2,
"id": 5,
})
if err != nil {
return fmt.Errorf("crm.category.delete: %w", err)
}
// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа, показанную ниже на этой странице.
fmt.Printf("%s\n", res.Result)
Ответ
HTTP-статус: 200
{
"result": null,
"time": {
"start": 1718288046.047386,
"finish": 1718288046.892514,
"duration": 0.845128059387207,
"processing": 0.4207921028137207,
"date_start": "2024-06-13T16:14:06+02:00",
"date_finish": "2024-06-13T16:14:06+02:00",
"operating": 0
}
}
Возвращаемые данные
result
null
Корневой элемент ответа, равный null
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 160
{
"error": "NOT_FOUND",
"error_description": "Элемент не найден"
}
| Код | Описание | Значение |
|---|---|---|
NOT_FOUND |
Смарт-процесс не найден | Возникает при некорректных значениях entityTypeId |
ENTITY_TYPE_NOT_SUPPORTED |
Entity type {entityTypeName} is not supported |
Возникает, если объект CRM не поддерживает воронки |
NOT_FOUND |
Элемент не найден | Возникает, если удаляемой воронки не существует |
REMOVING_DISABLED |
Удаление системной категории запрещено | Возникает, при попытке удалить системную воронку |
ACCESS_DENIED |
Доступ запрещен | Возникает, если у пользователя, удаляющего воронку, недостаточно прав |
0 |
Найдены сделки, относящиеся к воронке {categoryName} |
Возникает, если у удаляемой воронки есть хотя бы один элемент. Актуально только для сделок |
0 |
Default deal category can not be deleted | Возникает при попытке удалить воронку по умолчанию. Актуально только для сделок |
BX_ERROR |
Найдены элементы, относящиеся к воронке | Возникает, если у удаляемой воронки есть хотя бы один элемент. Актуально для смарт-процессов |
BX_ERROR |
Эта воронка является воронкой по умолчанию | Возникает при попытке удалить воронку по умолчанию. Актуально для смарт-процессов |

