POST /user_groups/{user_group_id}/members
Update the members of a user group. The user IDs must correspond to non-deactivated users.
Changes: Prior to Zulip 12.0 (feature level 496), bot users were not permitted to call this endpoint.
Prior to Zulip 11.0 (feature level 391), members could not be added or removed from a deactivated group.
Changes: Prior to Zulip 10.0 (feature level 303), group memberships of deactivated users were visible to the API and could be edited via this endpoint.
Servers
- https://{subdomain}.zulipchat.com/api/v1
- {server}/api/v1
- https://chat.zulip.org/api/v1
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
user_group_id |
Integer | Yes |
The ID of the target user group. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/x-www-form-urlencoded" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
add_subgroups[] |
Array | No |
The list of user group IDs to be added to the user group. Changes: New in Zulip 10.0 (feature level 311). |
delete_subgroups[] |
Array | No |
The list of user group IDs to be removed from the user group. Changes: New in Zulip 10.0 (feature level 311). |
delete[] |
Array | No |
The list of user IDs to be removed from the user group. |
add[] |
Array | No |
The list of user IDs to be added to the user group. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.