summary refs log tree commit diff
path: root/docs/admin_api/delete_group.md
diff options
context:
space:
mode:
authorErik Johnston <erik@matrix.org>2019-04-03 16:07:34 +0100
committerErik Johnston <erik@matrix.org>2019-04-03 16:29:52 +0100
commitc192bf89702ab24d36a442d1115045cbd6e9c876 (patch)
tree36bbf02f89dfad2ac15a9ea809d32df0fd13481f /docs/admin_api/delete_group.md
parentAdd functions to delete a group (diff)
downloadsynapse-c192bf89702ab24d36a442d1115045cbd6e9c876.tar.xz
Add admin API for group deletion
Diffstat (limited to 'docs/admin_api/delete_group.md')
-rw-r--r--docs/admin_api/delete_group.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/admin_api/delete_group.md b/docs/admin_api/delete_group.md
new file mode 100644
index 0000000000..d703d108b0
--- /dev/null
+++ b/docs/admin_api/delete_group.md
@@ -0,0 +1,14 @@
+# Delete a local group
+
+This API lets a server admin delete a local group. Doing so will kick all
+users out of the group so that their clients will correctly handle the group
+being deleted.
+
+
+The API is:
+
+```
+POST /_matrix/client/r0/admin/delete_group/<group_id>
+```
+
+including an `access_token` of a server admin.