Namespace: microsoft.graph
Important
APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Update the metadata for a bundle of driveItems by ID.
You can only update the following metadata:
- Bundle name
- Album
coverImageItemId (if applicable)
Any other change requests are ignored.
This API is available in the following national cloud deployments.
| Global service |
US Government L4 |
US Government L5 (DOD) |
China operated by 21Vianet |
| ✅ |
✅ |
✅ |
✅ |
Permissions
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
| Permission type |
Least privileged permissions |
Higher privileged permissions |
| Delegated (work or school account) |
Not supported. |
Not supported. |
| Delegated (personal Microsoft account) |
Files.ReadWrite |
Files.ReadWrite.All |
| Application |
Not supported. |
Not supported. |
HTTP request
PATCH /drive/items/{bundle-id}
| Name |
Description |
| Authorization |
Bearer {token}. Required. Learn more about authentication and authorization. |
| if-match |
eTag. Optional. If this request header is included and the eTag provided doesn't match the current eTag on the bundle, a 412 Precondition Failed response is returned. |
Request body
In the request body, supply the values for relevant fields that should be
updated. Existing properties that aren't included in the request body
maintain their previous values or are recalculated based on changes to other
property values. For best performance, don't include existing values that didn't change.
Response
If successful, this method returns a driveItem resource that represents the updated bundle in the response body.
Read the Error Responses article for more info about how errors are returned.
Example
This example renames a bundle.
Request
The following example shows a request.
PATCH https://graph.microsoft.com/beta/drive/items/{bundle-id}
Content-Type: application/json
{
"name": "Shared legal agreements"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Models;
var requestBody = new DriveItem
{
Name = "Shared legal agreements",
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Drives["{drive-id}"].Items["{driveItem-id}"].PatchAsync(requestBody);
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
//other-imports
)
requestBody := graphmodels.NewDriveItem()
name := "Shared legal agreements"
requestBody.SetName(&name)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
items, err := graphClient.Drives().ByDriveId("drive-id").Items().ByDriveItemId("driveItem-id").Patch(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
DriveItem driveItem = new DriveItem();
driveItem.setName("Shared legal agreements");
DriveItem result = graphClient.drives().byDriveId("{drive-id}").items().byDriveItemId("{driveItem-id}").patch(driveItem);
const options = {
authProvider,
};
const client = Client.init(options);
const driveItem = {
name: 'Shared legal agreements'
};
await client.api('/drive/items/{bundle-id}')
.version('beta')
.update(driveItem);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\DriveItem;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new DriveItem();
$requestBody->setName('Shared legal agreements');
$result = $graphServiceClient->drives()->byDriveId('drive-id')->items()->byDriveItemId('driveItem-id')->patch($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Files
$params = @{
name = "Shared legal agreements"
}
Update-MgBetaDriveItem -DriveId $driveId -DriveItemId $driveItemId -BodyParameter $params
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.drive_item import DriveItem
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = DriveItem(
name = "Shared legal agreements",
)
result = await graph_client.drives.by_drive_id('drive-id').items.by_drive_item_id('driveItem-id').patch(request_body)
Response
The following example shows the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "0123456789abc",
"name": "Shared legal agreements",
"bundle": {
"childCount": 3
}
}