Удалить по метке

DELETE /v1/notifications/by-tag/:tag

Удаляет все уведомления приложения с указанной меткой tag разом. Метку задают при отправке в поле tag. Удаление затрагивает только уведомления, отправленные этим же приложением.

Операция доступна только для ключа OAuth-приложения — метка привязана к приложению, поэтому запрос должен нести оба заголовка: X-Api-Key с ключом приложения и Authorization: Bearer с сессионным токеном пользователя. С личным ключом запрос возвращает 403 BITRIX_ACCESS_DENIED.

Параметры

Параметр Тип Обяз. Описание
tag (path) string да Метка tag, с которой уведомления были отправлены через `POST /v1/notifications`

Примеры

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

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/notifications/by-tag/deal-1024', {
  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 — вызов с личным ключом, метка приложения недоступна:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ACCESS_DENIED",
    "message": "Access denied! Client ID not specified"
  }
}

Ошибки

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

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

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

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

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