метод REST
scope: crm
crm.documentgenerator.document.delete
Удалить документ
Описание
Метод crm.documentgenerator.document.delete удаляет документ.
Параметры
id
integer
необязательный
Идентификатор документа
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":61}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.documentgenerator.document.delete
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":61,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.documentgenerator.document.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.documentgenerator.document.delete',
params: {
id: 61,
},
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('Document deleted, result:', 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 deleteDocument() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.documentgenerator.document.delete',
params: {
id: 61,
},
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('Document deleted, result:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', deleteDocument)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.documentgenerator.document.delete(bitrix_id=61).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.documentgenerator.document.delete',
[
'id' => 61,
]
);
$result = $response
->getResponseData()
->getResult();
echo '<pre>';
print_r($result);
echo '</pre>';
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error deleting document: ' . $e->getMessage();
}
BX24.callMethod(
'crm.documentgenerator.document.delete',
{
id: 61,
},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data())
;
},
);
require_once('crest.php');
$result = CRest::call(
'crm.documentgenerator.document.delete',
[
'id' => 61,
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.documentgenerator.document.delete", b24.Params{
"id": 61,
})
if err != nil {
return fmt.Errorf("crm.documentgenerator.document.delete: %w", err)
}
// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа, показанную ниже на этой странице.
fmt.Printf("%s\n", res.Result)
Ответ
HTTP-статус: 200
{
"result": null,
"time": {
"start": 1774012671,
"finish": 1774012673.417656,
"duration": 2.4176559448242188,
"processing": 2,
"date_start": "2026-03-20T16:17:51+03:00",
"date_finish": "2026-03-20T16:17:53+03:00",
"operating_reset_at": 1774013271,
"operating": 1.5586001873016357
}
}
Возвращаемые данные
result
null
Корневой элемент ответа. Для метода удаления возвращается null
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "100",
"error_description": "Bitrix\\DocumentGenerator\\Document constructor must be is public"
}
| Код | Описание | Значение |
|---|---|---|
100 |
Bitrix\\DocumentGenerator\\Document constructor must be is public | Не передан обязательный параметр id |
0 |
Документ не найден | Документ с указанным id не найден |
DOCGEN_ACCESS_ERROR |
Access denied | Нет доступа к документу |
| — | Document not found | Документ не относится к модулю crm |
| — | Module documentgenerator is not installed | Модуль documentgenerator недоступен |

