little fixes
[akkoma] / docs / api / admin_api.md
index 5a090c720b7e46600dd8620be0cd530ec85240f5..a8c75d93ff8c78bd1e4651541dfd9a3c1392f45c 100644 (file)
@@ -60,9 +60,13 @@ Authentication is required and the user must be an admin.
 
 - Method: `POST`
 - Params:
-  - `nickname`
-  - `email`
-  - `password`
+  `users`: [
+    {
+      `nickname`,
+      `email`,
+      `password`
+    }
+  ]
 - Response: User’s nickname
 
 ## `/api/pleroma/admin/users/follow`
@@ -222,13 +226,25 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret
 
 ### Get an account registration invite token
 
-- Methods: `GET`
+- Methods: `POST`
 - Params:
   - *optional* `invite` => [
     - *optional* `max_use` (integer)
     - *optional* `expires_at` (date string e.g. "2019-04-07")
   ]
-- Response: invite token (base64 string)
+- Response:
+
+```json
+{
+  "id": integer,
+  "token": string,
+  "used": boolean,
+  "expires_at": date,
+  "uses": integer,
+  "max_use": integer,
+  "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
+}
+```
 
 ## `/api/pleroma/admin/users/invites`