Удалить задачу

DELETE /v1/tasks/:id

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

Параметры

Параметр Тип Обяз. Описание
id (path) number да ID задачи

Примеры

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

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/tasks/3871" \
  -H "X-Api-Key: YOUR_API_KEY"

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

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/tasks/3871', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

if (res.status === 204) {
  console.log('Задача удалена')
}

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/tasks/3871', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

if (res.status === 204) {
  console.log('Удалено')
}

Ответ

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

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

HTTP/1.1 204 No Content

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

404 — задача не найдена (или уже удалена):

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "task 999999999 not found"
  }
}

Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Задача с таким ID не найдена (в том числе если она уже была удалена)
403 SCOPE_DENIED API-ключ не имеет скоупа tasks
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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

Каскадное удаление вложенных ресурсов. После удаления задачи становятся недоступными её комментарии и записи учёта времени — отдельный DELETE для каждого из них не нужен. Попытка обратиться к ним по прежнему ID вернёт 422 BITRIX_ERROR с сообщением ITEM_NOT_FOUND_OR_NOT_ACCESSIBLE.

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