Skip to main content

Update Group

BETA

This endpoint is in beta and may change in future releases.

PATCH/workspace/{workspaceId}/groups/{groupId}

Updates group name, workspace-level permissions, or granular permissions.

Path Parameters
workspaceIdstringrequired
The unique identifier of the workspace.
groupIdstringrequired
The unique identifier of the group.
Request Body
namestringoptional
Updated name for the group.
permissionsobjectoptional
Updated workspace-level permissions for the group.
granularPermissionsarrayoptional
Updated list of granular permission rules for apps and datasources.
Error Responses
400
Body fails DTO validation, groupId is a default group (admin/builder/end-user), or a resource cannot be resolved.
403
ENABLE_EXTERNAL_API is not true, license missing, or token invalid.
404
workspaceId or groupId not found.
422
granularPermissions contains more than one applyToAll: true entry for the same resource type.
451
EXTERNAL_API license not active on the instance.
Request
curl -X PATCH "https://{your-domain}/api/ext/workspace/{workspaceId}/groups/{groupId}" -H "Authorization: Basic <access_token>" -H "Content-Type: application/json" -d '{}'

Response: 204 No Content