Groups - Update Group

Updates a specified workspace.

Permissions

This API call can be called by a service principal profile. For more information see: Service principal profiles in Power BI Embedded.

Required Scope

Workspace.ReadWrite.All

Limitations

  • For Shared capacities, only the name can be updated.
  • For Premium capacities, only the name and defaultDatasetStorageFormat can be updated.
  • The name must be unique inside an organization.

PATCH https://api.powerbi.com/v1.0/myorg/groups/{groupId}

URI Parameters

Name In Required Type Description
groupId
path True

string

uuid

The workspace ID

Request Body

Name Type Description
defaultDatasetStorageFormat

DefaultDatasetStorageFormat

The default dataset storage format in the group

name

string

The group name

Responses

Name Type Description
200 OK

OK

Examples

Example

Sample request

PATCH https://api.powerbi.com/v1.0/myorg/groups/e2284830-c8dc-416b-b19a-8cdcd2729332
{
  "name": "Updated Sales Results",
  "defaultDatasetStorageFormat": "Large"
}

Sample response

Definitions

Name Description
DefaultDatasetStorageFormat

The default dataset storage format in the group

UpdateGroupRequest

An update request for the group

DefaultDatasetStorageFormat

The default dataset storage format in the group

Name Type Description
Large

string

Large dataset storage format

Small

string

Small dataset storage format

UpdateGroupRequest

An update request for the group

Name Type Description
defaultDatasetStorageFormat

DefaultDatasetStorageFormat

The default dataset storage format in the group

name

string

The group name