add `/api/pleroma/disable_account` to `docs/api/pleroma_api.md`
authorEgor Kislitsyn <egor@kislitsyn.com>
Mon, 15 Apr 2019 09:39:42 +0000 (16:39 +0700)
committerEgor Kislitsyn <egor@kislitsyn.com>
Mon, 15 Apr 2019 09:39:42 +0000 (16:39 +0700)
docs/api/pleroma_api.md

index dbe2503006ee9a9a22281347b556560a3df9efa7..b9622f586c0ae7182eda4fbc4b4c55843750f75d 100644 (file)
@@ -61,6 +61,15 @@ Request parameters can be passed via [query strings](https://en.wikipedia.org/wi
 * Response: JSON. Returns `{"status": "success"}` if the deletion was successful, `{"error": "[error message]"}` otherwise
 * Example response: `{"error": "Invalid password."}`
 
+## `/api/pleroma/disable_account`
+### Disable an account
+* Method `POST`
+* Authentication: required
+* Params:
+    * `password`: user's password
+* Response: JSON. Returns `{"status": "success"}` if the account was successfully disabled, `{"error": "[error message]"}` otherwise
+* Example response: `{"error": "Invalid password."}`
+
 ## `/api/account/register`
 ### Register a new user
 * Method `POST`