Notify API reference

Notify API · Client

post/v1/client/inbox/markAuth

Mark inbox items

Marks up to 100 items (`ids`), or every item up to and including `before_id` ("mark all as read"), as `seen`, `read`, `unread`, `archived` or `unarchived`, and returns the new counts. Marking `read` also marks seen. Open streams get `item.updated` and `counts`. Safe to repeat: items already in that state do not change.

Request body

action*object

What to mark the items as.

idsarray

The items (at most 100). Give `ids` or `before_id`, not both.

before_idstring · uuid

Every item up to and including this one (item ids sort by time): "mark all as read" for what the user has loaded. Give `ids` or `before_id`, not both.

Response · 200 How many items changed, and the counts after.

updated*integer

Items that changed (an item already in that state is not counted).

counts*object

The counts after the change.

Example

Request

POST https://api.notify.productcraft.co/v1/client/inbox/mark
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

{
  "action": {},
  "ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "before_id": "00000000-0000-0000-0000-000000000000"
}

Response

{
  "updated": 0,
  "counts": {}
}