X-Git-Url: https://git.squeep.com/?a=blobdiff_plain;f=docs%2Fapi%2Fpleroma_api.md;h=30fac77dad7d20b1af3c70b7d83d1fe2cb6c82d4;hb=aab264db82054df470075c65ca25c42bbcc5d7a8;hp=c08ee9ecd33584bdf92c86bfdbfb49f3da289e43;hpb=377aa9fb90ff1c8537112f23bfc329f1ac0696b4;p=akkoma

diff --git a/docs/api/pleroma_api.md b/docs/api/pleroma_api.md
index c08ee9ecd..30fac77da 100644
--- a/docs/api/pleroma_api.md
+++ b/docs/api/pleroma_api.md
@@ -133,7 +133,7 @@ See [Admin-API](Admin-API.md)
 * Params (mutually exclusive):
     * `id`: a single notification id to read
     * `max_id`: read all notifications up to this id
-* Response: Notification entity/Array of Notification entities. In case of `max_id`, only the first 80 notifications will be returned.
+* Response: Notification entity/Array of Notification entities that were read. In case of `max_id`, only the first 80 read notifications will be returned.
 
 ## `/api/v1/pleroma/accounts/:id/subscribe`
 ### Subscribe to receive notifications for all statuses posted by a user
@@ -252,7 +252,7 @@ See [Admin-API](Admin-API.md)
 * Params:
     * `email`: email of that needs to be verified
 * Authentication: not required
-* Response: 204 No Content 
+* Response: 204 No Content
 
 ## `/api/v1/pleroma/mascot`
 ### Gets user mascot image
@@ -321,11 +321,21 @@ See [Admin-API](Admin-API.md)
 }
 ```
 
+## `/api/pleroma/change_email`
+### Change account email
+* Method `POST`
+* Authentication: required
+* Params:
+    * `password`: user's password
+    * `email`: new email
+* Response: JSON. Returns `{"status": "success"}` if the change was successful, `{"error": "[error message]"}` otherwise
+* Note: Currently, Mastodon has no API for changing email. If they add it in future it might be incompatible with Pleroma.
+
 # Pleroma Conversations
 
 Pleroma Conversations have the same general structure that Mastodon Conversations have. The behavior differs in the following ways when using these endpoints:
 
-1. Pleroma Conversations never add or remove recipients, unless explicitly changed by the user. 
+1. Pleroma Conversations never add or remove recipients, unless explicitly changed by the user.
 2. Pleroma Conversations statuses can be requested by Conversation id.
 3. Pleroma Conversations can be replied to.