Update User Group

Update the name or description of a user group.

PATCH https://dash.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")

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

result = client.update_user_group(request)
print(result)

curl -sSX PATCH https://dash.zulipchat.com/api/v1/user_groups/42 \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY \
    -d 'name=marketing team' \
    -d 'description=The marketing team.'

Arguments

group_id required

Example: 42

The ID of the target user group.


name required

Example: marketing team

The new name of the group.


description required

Example: The marketing team.

The new description of the group.


Response

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