aboutsummaryrefslogtreecommitdiff
path: root/docs/development/API/admin_api.md
diff options
context:
space:
mode:
authorAlex Gleason <alex@alexgleason.me>2021-12-23 23:39:07 -0600
committerAlex Gleason <alex@alexgleason.me>2021-12-23 23:39:07 -0600
commit73cde0aeeb89e68c18bb0e3c0de1c6c975bf5dd8 (patch)
tree7ac29ef930383cbe56804336968a2563bc5c3555 /docs/development/API/admin_api.md
parent0dc132a543f1d96ab9892e6638596e7120a5254f (diff)
parent1fa616638b8823a6cc0d67d0354cc179da5943f8 (diff)
downloadpleroma-73cde0aeeb89e68c18bb0e3c0de1c6c975bf5dd8.tar.gz
Merge remote-tracking branch 'origin/develop' into object-flake
Diffstat (limited to 'docs/development/API/admin_api.md')
-rw-r--r--docs/development/API/admin_api.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/docs/development/API/admin_api.md b/docs/development/API/admin_api.md
index 82483fae7..f14081893 100644
--- a/docs/development/API/admin_api.md
+++ b/docs/development/API/admin_api.md
@@ -261,6 +261,46 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret
}
```
+## `PATCH /api/v1/pleroma/admin/users/suggest`
+
+### Suggest a user
+
+Adds the user(s) to follower recommendations.
+
+- Params:
+ - `nicknames`: nicknames array
+- Response:
+
+```json
+{
+ users: [
+ {
+ // user object
+ }
+ ]
+}
+```
+
+## `PATCH /api/v1/pleroma/admin/users/unsuggest`
+
+### Unsuggest a user
+
+Removes the user(s) from follower recommendations.
+
+- Params:
+ - `nicknames`: nicknames array
+- Response:
+
+```json
+{
+ users: [
+ {
+ // user object
+ }
+ ]
+}
+```
+
## `GET /api/v1/pleroma/admin/users/:nickname_or_id`
### Retrive the details of a user