PUT /groups/{groupId}

Replaces the entire group and returns the updated group. 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	No	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
`usage_analytics_access`	Boolean	No	Whether the group has access to usage analytics.
`account_details_access`	Boolean	No	Whether the group has access to account details.
`user_invites[]`	Array	No	A list of user invites that will be added to the group.
`user_invites[].id`	Number	Yes
`user_invites[].invited_by`	String	Yes
`user_invites[].claimed_by`	String	Yes
`user_invites[].groups[]`	Array	No	The groups that the user is invited to
`user_invites[].groups[].id`	Number	Yes
`user_invites[].groups[].name`	String	Yes
`user_invites[].groups[].legacy_id`	Number	Yes
`user_invites[].claimed_at`	String	Yes
`user_invites[].metadata`	Object	Yes
`user_invites[].invite_link`	String	No	User invite link expires 7 days after generation.
`user_invites[].created_at`	String	Yes
`user_invites[].legacy_id`	Number	Yes
`user_invites[].invited_email`	String	Yes
`user_invites[].expires_at`	String	Yes
`user_invites[].user_type`	String	Yes	Valid values: `"mobile"` `"external"` `"default"`
`universal_workflow_access`	String	No	The universal workflow access level for the group. This denotes the access level that this group has for all workflows. Valid values: `"edit"` `"use"` `"own"` `"none"`
`universal_app_access`	String	No	The universal app access level for the group. This denotes the access level that this group has for all apps. Valid values: `"edit"` `"use"` `"own"` `"none"`
`universal_resource_access`	String	No	The universal resource access level for the group. This denotes the access level that this group has for all resources. Valid values: `"edit"` `"use"` `"own"` `"none"`
`updated_at`	String	No
`name`	String	No	The name of the group.
`landing_page_app_id`	String	No	The app ID of the landing page.
`universal_query_library_access`	String	No	Level of access that the group has to the Query Library. Valid values: `"edit"` `"use"` `"none"`
`unpublished_release_access`	Boolean	No	Whether the group has access to unpublished releases.
`audit_log_access`	Boolean	No	Whether the group has access to the audit log.
`created_at`	String	No
`theme_access`	Boolean	No	Whether the group has access to edit themes.
`user_list_access`	Boolean	No	Whether the group has access to the user list.

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.