Update a user group
PATCH https://ik1-133-73042.vs.sakura.ne.jp/api/v1/user_groups/{user_group_id}
Update the name or description of 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")
request = {
"group_id": user_group_id,
"name": "marketing",
"description": "The marketing team.",
}
result = client.update_user_group(request)
print(result)
curl -sSX PATCH https://ik1-133-73042.vs.sakura.ne.jp/api/v1/user_groups/33 \
-u BOT_EMAIL_ADDRESS:BOT_API_KEY \
--data-urlencode 'name=marketing team' \
--data-urlencode 'description=The marketing team.'
Parameters
user_group_id integer required in path
Example: 33
The ID of the target user group.
name string optional
Example: "marketing team"
The new name of the group.
Changes: Before Zulip 7.0 (feature level 165), this was
a required field.
description string optional
Example: "The marketing team."
The new description of the group.
Changes: Before Zulip 7.0 (feature level 165), this was
a required field.
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 response when the user group ID is invalid:
{
"code": "BAD_REQUEST",
"msg": "Invalid user group",
"result": "error"
}