Update User Group

Update the name or description of a user group.

PATCH https://chat.ix5.org/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")

request = {
    'group_id': group_id,
    'name': 'marketing',
    'description': 'The marketing team.',

result = client.update_user_group(request)

curl -sSX PATCH https://chat.ix5.org/api/v1/user_groups/42 \
    -d 'name=marketing team' \
    -d 'description=The marketing team.'


Argument Example Required Description
group_id 42 Yes

The ID of the group.

name "marketing team" Yes

The new name of the group.

description "The marketing team." Yes

The new description of the group.


Example response

A typical successful JSON response may look like:

    "msg": "",
    "result": "success"

An example JSON response when the user group ID is invalid:

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