Docs: Document new mandatory parameter.
authorlain <lain@soykaf.club>
Sun, 7 Jun 2020 18:23:17 +0000 (20:23 +0200)
committerlain <lain@soykaf.club>
Sun, 7 Jun 2020 18:23:17 +0000 (20:23 +0200)
docs/API/chats.md

index 81ff579413befef2a73b6b040db3daa7c800d359..9eb581943f6d3c678fe57c7b9d6da686314d4367 100644 (file)
@@ -75,13 +75,13 @@ Returned data:
 
 ### Marking a chat as read
 
-To set the `unread` count of a chat to 0, call
+To mark a number of messages in a chat up to a certain message as read, you can use
 
 `POST /api/v1/pleroma/chats/:id/read`
 
 
 Parameters:
-- last_read_id: Given this id, all chat messages until this one will be marked as read. This should always be used.
+- last_read_id: Given this id, all chat messages until this one will be marked as read. Required.
 
 
 Returned data: