Create a user group


Create a new 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 = {
    "name": "marketing",
    "description": "The marketing team.",
    "members": user_ids,
result = client.create_user_group(request)

curl -sSX POST \
    --data-urlencode name=marketing \
    --data-urlencode 'description=The marketing team.' \
    --data-urlencode 'members=[1, 2, 3, 4]' \
    --data-urlencode can_mention_group=11


name string required

Example: "marketing"

The name of the user group.

description string required

Example: "The marketing team."

The description of the user group.

members (integer)[] required

Example: [1, 2, 3, 4]

An array containing the user IDs of the initial members for the new user group.

can_mention_group object | integer optional

Example: 11

A group-setting value defining the set of users who have permission to mention the new group.

This setting cannot be set to "role:internet" and "role:owners" system groups.

Changes: Before Zulip 9.0 (feature level 258), the can_mention_group setting could only be set to an integer.

Changes: Before Zulip 8.0 (feature level 198), the can_mention_group setting was named can_mention_group_id.

New in Zulip 8.0 (feature level 191). Previously, groups could be mentioned if and only if they were not system groups.


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 error response for when the one of the users does not exist:

    "code": "BAD_REQUEST",
    "msg": "Invalid user ID: 500",
    "result": "error"