Docs: Add Chat mark_as_read docs

2020-05-04 13:12:21 +02:00 · 2020-05-04 13:12:21 +02:00 · 7ff2a7dae2
commit 7ff2a7dae2
parent b04328c3de
1 changed files with 21 additions and 0 deletions
--- a/docs/API/chats.md
+++ b/docs/API/chats.md
@ -66,6 +66,27 @@ Returned data:
 }
 ```

+### Marking a chat as read
+
+To set the `unread` count of a chat to 0, call
+
+`POST /api/v1/pleroma/chats/:id/read`
+
+Returned data:
+
+```json
+{
+  "account": {
+    "id": "someflakeid",
+    "username": "somenick",
+    ...
+  },
+  "id" : "1",
+  "unread" : 0
+}
+```
+
+
 ### Getting a list of Chats

 `GET /api/v1/pleroma/chats`