Update user group members

Update the members of a user group.

POST https://hyperfoil.zulipchat.com/api/v1/user_groups/{user_group_id}/members

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

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

curl -sSX POST https://hyperfoil.zulipchat.com/api/v1/user_groups/1/members \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY \
    --data-urlencode add='[12, 13]'

Parameters

user_group_id required in path

Example: 1

The ID of the target user group.


delete optional

Example: [10]

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


add optional

Example: [12, 13]

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


Response

Example response

A typical successful JSON response may look like:

{
    "msg": "",
    "result": "success"
}