Home

Integrations

Interactive bots (beta)

REST API

Messages

Streams

Users

Server & organizations

Real-time events

Specialty endpoints

Back to Zulip

Update User Group

Update the name or description of a user group.

PATCH https://chat.zymocosm.com/api/v1/user_groups/{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")

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

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


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

Arguments

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.

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