2019-04-03 09:07:34 -06:00
|
|
|
# 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.
|
|
|
|
|
|
2022-01-31 09:24:29 -07:00
|
|
|
To use it, you will need to authenticate by providing an `access_token`
|
|
|
|
|
for a server admin: see [Admin API](../usage/administration/admin_api).
|
|
|
|
|
|
2019-04-03 09:07:34 -06:00
|
|
|
The API is:
|
|
|
|
|
|
|
|
|
|
```
|
2019-05-01 08:18:58 -06:00
|
|
|
POST /_synapse/admin/v1/delete_group/<group_id>
|
2019-04-03 09:07:34 -06:00
|
|
|
```
|
