Mark notices read
Marks notices read, or without noticeIds every notice in the inbox, and returns the unread count after the change.
Ids of notices the person does not have are ignored, so repeating the request changes nothing.
Guide: Notices
A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.
In: header
Path parameters
The organization's id, org_....
Request body
application/json
TypeScript definitions
Use the request body type in TypeScript.
The notices to mark read, up to 200; omit to mark the whole inbox read.
Examples
curl -X POST "https://api.voidhash.com/api/v1/organizations/org_w5xk2e7q0lzv3n8b1c4d6f9g/notices/mark-read" \ -H "Authorization: Bearer vh_sk_..." \ -H "Content-Type: application/json" \ -d '{ "noticeIds": [ "notice_p4r7t0y3u6i9o2a5s8d1f4g7" ] }'{ "organizationId": "org_w5xk2e7q0lzv3n8b1c4d6f9g", "count": 2}{ "error": { "type": "invalid_request", "code": "invalid_body", "message": "The request body is invalid: Expected object" }}{ "error": { "type": "unauthenticated", "code": "invalid_api_key", "message": "This secret key is not valid." }}{ "error": { "type": "permission_denied", "code": "permission_denied", "message": "Insufficient permissions." }}{ "error": { "type": "not_found", "code": "organization_not_found", "message": "There is no organization org_w5xk2e7q0lzv3n8b1c4d6f9g, or this credential cannot use it.", "param": "organizationId" }}{ "error": { "type": "internal", "code": "internal_error", "message": "Something went wrong on our side. Try again, and contact support with the Request-Id header if it keeps failing." }}Response body
application/json
application/json
application/json
application/json
application/json
application/json
Errors
This operation adds no error codes of its own. It can fail with the errors every operation shares, such as unauthenticated; see Errors.
More in Notices
- List notices
GET - Count unread notices
GET - Archive notices
POST - Unarchive notices
POST - Retrieve notice preferences
GET - Update notice preferences
PATCH
Something wrong or missing on this page? Tell us by email or on Discord.