Для AI-агентов: markdown этой страницы — /docs-content/entities/recurring-deals/delete.md индекс документации — /llms.txt

Удалить настройку

DELETE /v1/recurring-deals/:id

Удаляет настройку автоматического повторения сделки по её идентификатору. Восстановить удалённую настройку через API нельзя.

Параметры

Параметр Тип Обяз. Описание
Параметрid (path) Типnumber Обяз.да ОписаниеID настройки, целое неотрицательное число в безопасном диапазоне. Источник — список регулярных сделок

Примеры

curl — личный ключ

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/recurring-deals/11" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/recurring-deals/11" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

javascript 
const response = await fetch('https://vibecode.bitrix24.tech/v1/recurring-deals/11', {
  method: 'DELETE',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
if (response.status !== 204) throw new Error(await response.text())

JavaScript — OAuth-приложение

javascript 
const response = await fetch('https://vibecode.bitrix24.tech/v1/recurring-deals/11', {
  method: 'DELETE',
  headers: { 'X-Api-Key': 'YOUR_APP_KEY', 'Authorization': 'Bearer USER_SESSION_TOKEN' },
})
if (response.status !== 204) throw new Error(await response.text())

Ответ

При успешном удалении возвращается HTTP-статус 204 No Content с пустым телом. Признак успеха — код ответа.

Пример ответа

http 
HTTP/1.1 204 No Content

Пример ответа при ошибке

422 — существует связанная сделка-шаблон:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Deleting is impossible. Connected recurring deal exists."
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS Описаниеid не является целым неотрицательным числом в безопасном диапазоне
HTTP404 КодENTITY_NOT_FOUND ОписаниеНастройка не найдена. Сообщение: Recurring deal is not found.
HTTP422 КодBITRIX_ERROR ОписаниеСуществует связанная сделка-шаблон. Сообщение: Deleting is impossible. Connected recurring deal exists.
HTTP401 КодMISSING_API_KEY ОписаниеНе передан заголовок X-Api-Key
HTTP401 КодTOKEN_MISSING ОписаниеНет настроенных токенов доступа к Битрикс24
HTTP403 КодMANAGEMENT_KEY_NO_ENTITY_ACCESS ОписаниеКлюч управления не имеет доступа к методам сущностей
HTTP403 КодSCOPE_DENIED ОписаниеAPI-ключ не имеет скоупа crm
HTTP403 КодWRITE_BLOCKED_READONLY_KEY ОписаниеПосле проверки скоупа запись запрещена режимом ключа «только чтение»
HTTP403 КодBITRIX_ACCESS_DENIED ОписаниеБитрикс24 отказал в доступе
HTTP422 КодBITRIX_ERROR ОписаниеБизнес-отказ Битрикс24 или ограничение тарифа. Причина — в error.message
HTTP503 КодBITRIX_TIMEOUT ОписаниеБитрикс24 не ответил вовремя
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеСетевой сбой или ошибка сервера Битрикс24 с HTTP-статусом 500 и выше
HTTP429 КодRATE_LIMITED ОписаниеПревышен лимит запросов. Повторите после срока из заголовка Retry-After

Полный список общих ошибок API — Ошибки.

Известные особенности

Смотрите также