Merge branch 'develop' of git.pleroma.social:pleroma/pleroma into remake-remodel-dms

[akkoma] / docs / API / chats.md

diff --git a/docs/API/chats.md b/docs/API/chats.md
index 26e83570e821bc095ae74df316df3bd0c4102617..8d925989c459df793919688474cd13aa5bba619a 100644 (file)
--- 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`