Cowdidocs
API ReferenceNotification Inbox

Archive many notifications

POST
/v1/user/notifications/archive

Archives the messages that are not archived and not snoozed now. Send no body, or omit read, to archive all of them. Send read: true to archive only the read messages. Send read: false to archive only the unread messages. Archiving also marks a message as seen and read.

Authorization

oauth2
AuthorizationBearer <token>

Create a client with POST /v1/oauth/clients, then exchange its credentials for an access token. AUTHORIZATION_CODE clients act on behalf of a signed-in user and always use PKCE; CLIENT_CREDENTIALS clients act as themselves. A client may only be granted scopes its creator already holds — read the grantable list from GET /v1/oauth/clients/scopes.

In: header

Request Body

application/json

The messages to archive. The request skips archived messages and messages snoozed now.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/user/notifications/archive" \  -H "Content-Type: application/json" \  -d '{}'
{  "updated_count": 0}
{  "code": "BAD_REQUEST",  "description": "Bad Request"}
{  "code": "UNAUTHORISED",  "description": "Unauthorised"}
{  "code": "FORBIDDEN",  "description": "Forbidden"}
{  "code": "RATE_LIMIT_EXCEEDED",  "description": "Too Many Requests"}
{  "code": "INTERNAL_ERROR",  "description": "Internal Server Error"}

List my notifications GET

Newest first. Omit read and archived to list everything that is not snoozed now; pass read=false&archived=false for the outstanding work. Pass snoozed=true for the snoozed messages.

Count what is waiting GET

Messages that are not read and not snoozed now. Archiving a message also reads it.