Create User Group

Create a new user group.

POST https://yourZulipDomain.zulipchat.com/api/v1/user_groups/create

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': [7, 8, 9, 10],
}

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

curl -X POST https://yourZulipDomain.zulipchat.com/api/v1/user_groups/create \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY \
    -d 'name="marketing"' \
    -d 'description="The marketing team"' \
    -d 'members=[1,2,3,4]'

Arguments

Argument Example Required Description
name "marketing" Yes

The name of the user group.

description "The marketing team." Yes

The description of the user group.

members [1,2,3,4] Yes

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

Response

Example response

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