API ReferenceNotifications

Mark notifications read

POST /rest/v1/notifications/read

POST
/notifications/read

All of them when ids is omitted. Ids are the ntf_ ids of GET /notifications; each must be one of this company's notifications (404 notification_not_found, param = ids[n], nothing marked otherwise). An empty ids array is refused (422). Required scope: events:read.

AuthorizationBearer <token>

Authorization: Bearer nbl_live_... (or nbl_test_... for test mode). Test-mode writes are validated and simulated but never persisted and never touch channels; simulated results are marked simulated.

In: header

Header Parameters

Idempotency-Key?string

Unique client-generated key (max 255 chars), stored 24h.

Lengthlength <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/notifications/read" \  -H "Content-Type: application/json" \  -d '{}'
{  "object": "notifications_read",  "ids": [    "string"  ]}

Last updated on October 19, 2026

Need help?

Email us and a human replies, usually within one business day.