Delete a user group

DELETE https://zulip.bigw.org/api/v1/user_groups/{user_group_id}

Delete a user group.

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(user_group_id)
print(result)

curl -sSX DELETE https://zulip.bigw.org/api/v1/user_groups/33 \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY

Parameters

Response

Example response(s)

Changes: As of Zulip 7.0 (feature level 167), if any parameters sent in the request are not supported by this endpoint, a successful JSON response will include an ignored_parameters_unsupported array.

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"
}