POST /user_groups/create
Create a new user group.
Changes: Prior to Zulip 12.0 (feature level 496), bot users were not permitted to call this endpoint.
Servers
- https://{subdomain}.zulipchat.com/api/v1
- {server}/api/v1
- https://chat.zulip.org/api/v1
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 |
|---|---|---|---|
members[] |
Array | Yes |
An array containing the user IDs of the initial members for the new user group. |
can_leave_group |
No |
A group-setting value defining the set of users who have permission to leave this user group. Changes: New in Zulip 10.0 (feature level 308). |
|
can_manage_group |
No |
A group-setting value defining the set of users who have permission to manage this user group. This setting cannot be set to Changes: New in Zulip 10.0 (feature level 283). |
|
name |
String | Yes |
The name of the user group. |
description |
String | Yes |
The description of the user group. |
can_mention_group |
No |
A group-setting value defining the set of users who have permission to mention this user group. This setting cannot be set to Before Zulip 9.0 (feature level 258), this parameter could only be the integer form of a group-setting value. Before Zulip 8.0 (feature level 198), this parameter was named
New in Zulip 8.0 (feature level 191). Previously, groups could be mentioned only if they were not system groups. |
|
can_join_group |
No |
A group-setting value defining the set of users who have permission to join this user group. Changes: New in Zulip 10.0 (feature level 301). |
|
can_remove_members_group |
No |
A group-setting value defining the set of users who have permission to remove members from this user group. Changes: New in Zulip 10.0 (feature level 324). Previously, this
permission was controlled by the |
|
can_add_members_group |
No |
A group-setting value defining the set of users who have permission to add members to this user group. Changes: New in Zulip 10.0 (feature level 305). Previously, this
permission was controlled by the |
|
subgroups[] |
Array | No |
An array containing the IDs of the initial subgroups for the new user group. User can add subgroups to the new group irrespective of other permissions for the new group. Changes: New in Zulip 10.0 (feature level 311). |
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.