Zulip homepage

API documentation home

Integrations

Interactive bots (beta)

REST API

Messages

Drafts

Streams

Users

Server & organizations

Real-time events

Specialty endpoints

Back to Zulip

Update subgroups of a user group

POST https://sc1.zulip.engr.uconn.edu/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

curl -sSX POST https://sc1.zulip.engr.uconn.edu/api/v1/user_groups/29/subgroups \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY \
    --data-urlencode 'add=[8, 9]'

Parameters

user_group_id integer required in path

Example: 29

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

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

Response

Example response(s)

A typical successful JSON response may look like:

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