synapse/docs/admin_api/delete_group.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

15 lines
405 B
Markdown
Raw Normal View History

2019-04-03 17:07:34 +02: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.
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 17:07:34 +02:00
The API is:
```
2019-05-01 16:18:58 +02:00
POST /_synapse/admin/v1/delete_group/<group_id>
2019-04-03 17:07:34 +02:00
```