Update user group members

POST https://zulip.fairsharing.org/api/v1/user_groups/{user_group_id}/members

Update the members of a user group.

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 = {
    "delete": user_ids_to_remove,
    "add": user_ids_to_add,
}
result = client.update_user_group_members(user_group_id, request)
print(result)

curl -sSX POST https://zulip.fairsharing.org/api/v1/user_groups/33/members \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY \
    --data-urlencode 'add=[12, 13]'

Parameters

user_group_id integer required in path

Example: 33

The ID of the target user group.

delete (integer)[] optional

Example: [10]

The list of user IDs to be removed from the user group.

add (integer)[] optional

Example: [12, 13]

The list of user IDs to be added to the user group.

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

Zulip homepage

API documentation home

Integrations

Interactive bots (beta)

REST API

Messages

Scheduled messages

Drafts

Channels

Users

Invitations

Server & organizations

Real-time events

Specialty endpoints

Back to Zulip

Update user group members

Usage examples

Parameters

Response

Example response(s)