Update subgroups of a user group

Update the subgroups of a user group.

POST https://act4e.zulipchat.com/api/v1/user_groups/{user_group_id}/subgroups

Changes: New in Zulip 6.0 (feature level 127).

Usage examples

curl -sSX POST https://act4e.zulipchat.com/api/v1/user_groups/22/subgroups \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY \
    --data-urlencode 'add=[1, 2]'

Parameters

user_group_id integer required in path

Example: 22

The ID of the target user group.


delete (integer)[] optional

Example: [10]

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


add (integer)[] optional

Example: [1, 2]

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


Response

Example response

A typical successful JSON response may look like:

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