Zulip homepage

API documentation home

Integrations

Interactive bots (beta)

REST API

Messages

Drafts

Streams

Users

Server & organizations

Real-time events

Specialty endpoints

Back to Zulip

Delete a user group

Delete a user group.

DELETE https://z.labs.greyorange.com/api/v1/user_groups/{user_group_id}

Usage examples

  • Python
  • curl

#!/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://z.labs.greyorange.com/api/v1/user_groups/22 \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY

Parameters

user_group_id integer required in path

Example: 22

The ID of the target user 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"
}