summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAlex Gleason <alex@alexgleason.me>2021-11-26 15:19:01 -0600
committerAlex Gleason <alex@alexgleason.me>2021-11-26 15:19:01 -0600
commit6c0484d571e4ed4e39fa3f88e6e1d2d7b8de96fa (patch)
tree060de963fb213e8139c2eac39ab806470380ec7d /docs
parente28d990ecba287d5c44ed04c0039b43c8f309e50 (diff)
AdminAPI: suggest a user through the API
Diffstat (limited to 'docs')
-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 8f855d251..79531c45b 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