From 6b4cc9f3f60fc1ee7da25c80d1aaba6d38705f3f Mon Sep 17 00:00:00 2001
From: Shay <hillerys@element.io>
Date: Thu, 20 Feb 2025 10:40:30 -0800
Subject: Document suspension Admin API (#18162)

Missed in the transition from experimental to stable.

Fixes #18160
---
 docs/admin_api/user_admin_api.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

(limited to 'docs/admin_api/user_admin_api.md')

diff --git a/docs/admin_api/user_admin_api.md b/docs/admin_api/user_admin_api.md
index 2742d2d2cd..77ce800507 100644
--- a/docs/admin_api/user_admin_api.md
+++ b/docs/admin_api/user_admin_api.md
@@ -414,6 +414,32 @@ The following actions are **NOT** performed. The list may be incomplete.
 - Remove from monthly active users
 - Remove user's consent information (consent version and timestamp)
 
+## Suspend/Unsuspend Account
+
+This API allows an admin to suspend/unsuspend an account. While an account is suspended, the user is 
+prohibited from sending invites, joining or knocking on rooms, sending messages, changing profile data, and redacting messages other than their own. 
+
+The api is:
+
+```
+PUT /_synapse/admin/v1/suspend/<user_id>
+```
+
+with a body of:
+
+```json
+{
+    "suspend": true
+}
+```
+
+To unsuspend a user, use the same endpoint with a body of:
+```json
+{
+  "suspend": false
+}
+```
+
 ## Reset password
 
 **Note:** This API is disabled when MSC3861 is enabled. [See #15582](https://github.com/matrix-org/synapse/pull/15582)
-- 
cgit 1.5.1