Удалить все уведомления

DELETE /v1/notifications

Необратимо: удаляет все уведомления владельца ключа, восстановить нельзя. Вызывайте, только когда ленту нужно очистить полностью.

Параметры

Параметров и тела нет — только адрес. Любой параметр строки запроса и любое поле тела отклоняются с 400 INVALID_PARAMS до обращения к Битрикс24, и ничего не удаляется: идентификатор, переданный не в пути, не превращается в удаление всей ленты. Пустой объект {} в теле допустим.

Одно уведомление удаляет DELETE /v1/notifications/:id, уведомления с меткой — DELETE /v1/notifications/by-tag/:tag.

Примеры

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

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

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

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

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

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

const { success } = await res.json()
if (success) {
  console.log('Все уведомления удалены')
}

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

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

const { success } = await res.json()
if (success) {
  console.log('Все уведомления удалены')
}

Поля ответа

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

HTTP 200:

{
  "success": true,
  "data": {
    "result": true
  }
}

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

400 — передано поле тела, ничего не удалено:

{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Body field `id` is not accepted by DELETE /v1/notifications. It takes no body fields."
  }
}

Ошибки

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

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

• Удаляются уведомления владельца токена. По личному ключу — владельца ключа. По ключу OAuth-приложения с заголовком Authorization: Bearer — пользователя, чья это сессия.
• Удаляется вся лента, а не только уведомления вашего приложения: системные уведомления и уведомления других приложений портала тоже. Чтобы убрать только свои, отправляйте их с меткой tag и удаляйте по метке.
• Успех проверяйте по коду 200 и success: true. Удаление по идентификатору и по метке отвечает 204 без тела, эта операция — нет.
• Ответ не сообщает, сколько уведомлений удалено. Результат виден в ленте уведомлений: после вызова массив notifications пуст, totalCount и totalUnreadCount равны 0.

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

• Удалить по идентификатору
• Удалить по метке
• Лента уведомлений
• Ошибки