POST /groups/{groupId}/members
Adds specified user(s) to a group and returns the updated group. Can optionally set or unset group admins by using the is_group_admin property. If existing members are passed in, group admin status will be updated. You cannot remove members using this endpoint. Requires the groups:write scope.
Servers
- https://api.retool.com/api/v2
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
groupId |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
members[] |
Array | Yes |
Users to add to the group. |
members[].id |
String | Yes |
The unique identifier for the user. |
members[].is_group_admin |
Boolean | Yes |
Whether the user is a group admin. Default value: false |
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.