aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHaelwenn (lanodan) Monnier <contact@hacktivis.me>2020-03-02 04:01:37 +0100
committerHaelwenn (lanodan) Monnier <contact@hacktivis.me>2020-03-02 04:01:37 +0100
commitdeb5f5c40e638472ca5a01370ad127fc4c437150 (patch)
tree4419f4f9e7da69b0066ba0c22ad06f000b9ab234
parent6471c09372204a9fec20cd58492149862e389d24 (diff)
downloadpleroma-deb5f5c40e638472ca5a01370ad127fc4c437150.tar.gz
pleroma_api.md: direct_conversation_id vs. conversation_id
Related: https://git.pleroma.social/pleroma/pleroma/issues/1594
-rw-r--r--docs/API/pleroma_api.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/API/pleroma_api.md b/docs/API/pleroma_api.md
index 761d5c69c..12e63ef9f 100644
--- a/docs/API/pleroma_api.md
+++ b/docs/API/pleroma_api.md
@@ -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