diff options
| author | eugenijm <eugenijm@protonmail.com> | 2019-03-28 14:52:09 +0300 |
|---|---|---|
| committer | eugenijm <eugenijm@protonmail.com> | 2019-03-28 18:55:16 +0300 |
| commit | cd90695a349f33b84f287794bae6070e9eec446a (patch) | |
| tree | 92fc170ff80b7c066f7f795b1a3e91f81279edf2 /docs/Pleroma-API.md | |
| parent | 55d086b52077a220aef60c8d9071aea990431d74 (diff) | |
| download | pleroma-cd90695a349f33b84f287794bae6070e9eec446a.tar.gz pleroma-cd90695a349f33b84f287794bae6070e9eec446a.zip | |
Add PUT /api/pleroma/notification_settings endpoint
Diffstat (limited to 'docs/Pleroma-API.md')
| -rw-r--r-- | docs/Pleroma-API.md | 14 |
1 files changed, 12 insertions, 2 deletions
diff --git a/docs/Pleroma-API.md b/docs/Pleroma-API.md index 478c9d874..bb7ed3744 100644 --- a/docs/Pleroma-API.md +++ b/docs/Pleroma-API.md @@ -27,14 +27,14 @@ Request parameters can be passed via [query strings](https://en.wikipedia.org/wi * Method: `GET` * Authentication: not required * Params: none -* Response: Provider specific JSON, the only guaranteed parameter is `type` +* Response: Provider specific JSON, the only guaranteed parameter is `type` * Example response: `{"type": "kocaptcha", "token": "whatever", "url": "https://captcha.kotobank.ch/endpoint"}` ## `/api/pleroma/delete_account` ### Delete an account * Method `POST` * Authentication: required -* Params: +* Params: * `password`: user's password * Response: JSON. Returns `{"status": "success"}` if the deletion was successful, `{"error": "[error message]"}` otherwise * Example response: `{"error": "Invalid password."}` @@ -116,3 +116,13 @@ See [Admin-API](Admin-API.md) * Params: * `id`: notifications's id * Response: JSON. Returns `{"status": "success"}` if the reading was successful, otherwise returns `{"error": "error_msg"}` +## `/api/pleroma/notification_settings` +### Updates user notification settings +* Method `PUT` +* Authentication: required +* Params: + * `followers`: BOOLEAN field, receives notifications from followers + * `follows`: BOOLEAN field, receives notifications from people the user follows + * `remote`: BOOLEAN field, receives notifications from people on remote instances + * `local`: BOOLEAN field, receives notifications from people on the local instance +* Response: JSON. Returns `{"status": "success"}` if the update was successful, otherwise returns `{"error": "error_msg"}` |