Update subgroups of a user group

POST https://zulip2.ca.rsc.tohtech.ac.jp/api/v1/user_groups/{user_group_id}/subgroups

Update the subgroups of a user group.

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

Usage examples

curl -sSX POST https://zulip2.ca.rsc.tohtech.ac.jp/api/v1/user_groups/33/subgroups \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY \
    --data-urlencode 'add=[9, 10]'

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 group IDs to be removed from the user group.


add (integer)[] optional

Example: [9, 10]

The list of user group 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"
}