PATCH /user_groups/{user_group_id}
Update the name, description or any of the permission settings of a user group.
This endpoint is also used to reactivate a user group.
Note that while permissions settings of deactivated groups can be edited by this API endpoint, and those permissions settings do affect the ability to modify the deactivated group and its membership, the deactivated group itself cannot be mentioned or used in the value of any permission without first being reactivated.
Changes: Prior to Zulip 12.0 (feature level 496), bot users were not permitted to call this endpoint.
Starting with Zulip 11.0 (feature level 386), this endpoint can be used to reactivate a user group.
Prior to Zulip 10.0 (feature level 340), only the name field of deactivated groups could be modified.
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 |
|---|---|---|---|
name |
String | No |
The new name of the group. Changes: Before Zulip 7.0 (feature level 165), this was a required field. |
description |
String | No |
The new description of the group. Changes: Before Zulip 7.0 (feature level 165), this was a required field. |
deactivated |
Boolean | No |
A deactivated user group can be reactivated by passing this
parameter as Passing Changes: New in Zulip 11.0 (feature level 386). |
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.