Notifications
Routes in this group. Authentication, scope and rate limit errors apply to every route and are on the errors page.
GET/notifications
List your notices, newest first.
- Scope
projects:read- Rate bucket
read, 240 a minute per key
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
limit | query | integer | No | min 1, max 100, default 50 |
offset | query | integer | No | min 0, default 0 |
unread | query | boolean | No | default false |
Request. Query: limit (1 to 100, default 50), offset and unread (true for unread only). Needs projects:read. A key bound to one project sees only that project's notices.
Returns. The notices, with unreadCount, total and hasMore.
GET/notifications/preferences
Read your email switches per notice kind.
- Scope
projects:read- Rate bucket
read, 240 a minute per key
Request. No body. Needs projects:read.
Returns. preferences: for each kind, whether email is on. Security kinds show locked true and email true.
PUT/notifications/preferences
Change your email switches.
- Scope
projects:write- Rate bucket
write, 60 a minute per key
Request. JSON body {"email": {"batch_finished": false}} with at least one kind and boolean values. Needs projects:write. The preference belongs to the account, so a key bound to one project is refused.
Returns. The preferences after the change.
Errors specific to this route. 403 project_bound_key, 422 invalid_request, 422 invalid_preference, 413 request_too_large. Authentication, scope and rate limit errors apply to every route.
POST/notifications/read-all
Mark every notice you can see as read.
- Scope
projects:write- Rate bucket
write, 60 a minute per key
Request. No body. Needs projects:write.
Returns. changed (how many notices were marked) and unreadCount.
POST/notifications/{notificationId}/read
Mark one notice as read.
- Scope
projects:write- Rate bucket
write, 60 a minute per key
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
notificationId | path | string | Yes |
Request. Path: the notice id. Needs projects:write.
Returns. id, read and unreadCount.
Errors specific to this route. 404 notification_not_found. Authentication, scope and rate limit errors apply to every route.