diff options
| author | Erik Johnston <erikj@jki.re> | 2019-04-04 14:15:41 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-04-04 14:15:41 +0100 |
| commit | 616e6a10bd763c7994e753458102db799adae1c6 (patch) | |
| tree | 0637b25a2b54503b1e3eb2734956851d4036b4e9 /docs/admin_api/delete_group.md | |
| parent | Prevent kicking users who aren't in the room (#4999) (diff) | |
| parent | Newsfile (diff) | |
| download | synapse-616e6a10bd763c7994e753458102db799adae1c6.tar.xz | |
Merge pull request #5002 from matrix-org/erikj/delete_group
Add delete group admin API
Diffstat (limited to 'docs/admin_api/delete_group.md')
| -rw-r--r-- | docs/admin_api/delete_group.md | 14 |
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. |