pleroma_api.md: direct_conversation_id vs. conversation_id
authorHaelwenn (lanodan) Monnier <contact@hacktivis.me>
Mon, 2 Mar 2020 03:01:37 +0000 (04:01 +0100)
committerrinpatch <rinpatch@sdf.org>
Sun, 15 Mar 2020 14:00:30 +0000 (17:00 +0300)
Related: https://git.pleroma.social/pleroma/pleroma/issues/1594

docs/API/pleroma_api.md

index 761d5c69cd485947bdef00e00dfc52687f033b58..12e63ef9f75e8c96bdf38789b18a601a41c31d2d 100644 (file)
@@ -288,10 +288,11 @@ Pleroma Conversations have the same general structure that Mastodon Conversation
 2. Pleroma Conversations statuses can be requested by Conversation id.
 3. Pleroma Conversations can be replied to.
 
-Conversations have the additional field "recipients" under the "pleroma" key. This holds a list of all the accounts that will receive a message in this conversation.
+Conversations have the additional field `recipients` under the `pleroma` key. This holds a list of all the accounts that will receive a message in this conversation.
 
 The status posting endpoint takes an additional parameter, `in_reply_to_conversation_id`, which, when set, will set the visiblity to direct and address only the people who are the recipients of that Conversation.
 
+⚠ Conversation IDs can be found in direct messages with the `pleroma.direct_conversation_id` key, do not confuse it with `pleroma.conversation_id`.
 
 ## `GET /api/v1/pleroma/conversations/:id/statuses`
 ### Timeline for a given conversation