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

Отметить все прочитанными

POST /v1/notifications/read-all

Отмечает прочитанными все уведомления владельца ключа одним вызовом, без перечня их идентификаторов.

Поля запроса (body)

Поле Тип Обяз. Описание
excludeIds number[] нет Уведомления, которые остаются непрочитанными, — от 0 до 100 положительных целых идентификаторов. Идентификатор — поле id уведомления в ленте или notificationId из ответа POST /v1/notifications. Пустой список равнозначен отсутствию поля

Тело можно не передавать — тогда не передавайте и заголовок Content-Type: application/json. Любое другое поле тела и любой параметр строки запроса отклоняются с 400 INVALID_PARAMS до обращения к Битрикс24.

Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/notifications/read-all" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "excludeIds": [38964] }'

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/notifications/read-all" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "excludeIds": [38964] }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/notifications/read-all', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ excludeIds: [38964] }),
})

const { data } = await res.json()
console.log('Непрочитанных осталось:', data.counter)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/notifications/read-all', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ excludeIds: [38964] }),
})

const { data } = await res.json()

Поля ответа

Поле Тип Описание
success boolean true при успешном выполнении
data.counter number Счётчик непрочитанных уведомлений после вызова
data.excludeIds number[] Уведомления, оставленные непрочитанными: переданные в excludeIds и подтверждения — уведомления с кнопками ответа

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

HTTP 200:

JSON 
{
  "success": true,
  "data": {
    "counter": 1,
    "excludeIds": [38964]
  }
}

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

400 — поле ids вместо excludeIds:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Body field `ids` is not accepted by POST /v1/notifications/read-all. Accepted: excludeIds."
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS excludeIds — не массив из 0–100 положительных целых идентификаторов, передано другое поле тела или параметр строки запроса либо тело не является объектом JSON. Поле названо в сообщении. Проверяется до обращения к Битрикс24
400 FST_ERR_CTP_EMPTY_JSON_BODY Передан заголовок Content-Type: application/json, а тело пустое. Отправьте {} или уберите заголовок
422 BITRIX_ERROR Битрикс24 отклонил вызов. Код портала — в поле error.b24Code
403 SCOPE_DENIED У ключа нет скоупа im
403 WRITE_BLOCKED_READONLY_KEY Ключ в режиме «только чтение»
401 TOKEN_MISSING У ключа нет настроенных токенов

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

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

  • Подтверждения — уведомления с кнопками ответа — операция не отмечает: они остаются непрочитанными, даже если не названы в excludeIds.
  • Отмечаются уведомления владельца токена. По личному ключу — владельца ключа. По ключу OAuth-приложения с заголовком Authorization: Bearer — пользователя, чья это сессия.
  • Отметить прочитанными только выбранные уведомления — режим v2 операции Отметить прочитанными с полем ids.

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