Delete a user group

Delete a user group.

DELETE https://yourZulipDomain.zulipchat.com/api/v1/user_groups/{group_id}

Usage examples

#!/usr/bin/env python3

import zulip

# Pass the path to your zuliprc file here.
client = zulip.Client(config_file="~/zuliprc")

result = client.remove_user_group(group_id)
print(result)

curl -sSX DELETE https://yourZulipDomain.zulipchat.com/api/v1/user_groups/42 \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY

Arguments

Argument Example Required Description
group_id 42 Yes

The ID of the group.

Response

Example response

A typical successful JSON response may look like:

{
    "msg": "",
    "result": "success"
}

An example JSON error response for an invalid user group id:

{
    "code": "BAD_REQUEST",
    "msg": "Invalid user group",
    "result": "error"
}