Удалить по идентификатору

DELETE /v1/notifications/:id

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

Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор уведомления из ответа `POST /v1/notifications`

Примеры

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

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

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

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/notifications/37421', {
  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/notifications/37421', {
  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 
HTTP/1.1 204 No Content

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

403 — нет скоупа im:

JSON 
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'im' scope"
  }
}

Ошибки

HTTP Код Описание
403 SCOPE_DENIED У ключа нет скоупа im
403 WRITE_BLOCKED_READONLY_KEY Ключ в режиме «только чтение»
401 TOKEN_MISSING У ключа нет настроенных токенов

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

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

  • Запрос на несуществующий id тоже возвращает 204 — по коду ответа нельзя отличить удаление реального уведомления от удаления уже отсутствующего.

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