Merge branch 'develop' of https://git.pleroma.social/pleroma/pleroma into develop

[akkoma] / docs / api / pleroma_api.md

diff --git a/docs/api/pleroma_api.md b/docs/api/pleroma_api.md
index 4323e59f0e9db38459541f71b07675e121500212..b134b31a8421b4068c81d4f11c9a33e910413041 100644 (file)
--- a/docs/api/pleroma_api.md
+++ b/docs/api/pleroma_api.md
@@ -340,11 +340,17 @@ The status posting endpoint takes an additional parameter, `in_reply_to_conversa
 * Params: Like other timelines
 * Response: JSON, statuses (200 - healthy, 503 unhealthy).
 
+## `GET /api/v1/pleroma/conversations/:id`
+### The conversation with the given ID.
+* Method `GET`
+* Authentication: required
+* Params: None
+* Response: JSON, statuses (200 - healthy, 503 unhealthy).
 
 ## `PATCH /api/v1/pleroma/conversations/:id`
 ### Update a conversation. Used to change the set of recipients.
 * Method `PATCH`
 * Authentication: required
 * Params:
-    * `recipients`: A list of ids of users that should receive posts to this conversation.
+    * `recipients`: A list of ids of users that should receive posts to this conversation. This will replace the current list of recipients, so submit the full list. The owner of owner of the conversation will always be part of the set of recipients, though.
 * Response: JSON, statuses (200 - healthy, 503 unhealthy)