Update DriveItem properties
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 DriveItem by ID or path.
You can also use update to move an item to another parent by updating the item's parentReference property.
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) | Files.ReadWrite | Files.ReadWrite.All, Sites.ReadWrite.All |
Delegated (personal Microsoft account) | Files.ReadWrite | Files.ReadWrite.All |
Application | Files.ReadWrite.All | Sites.ReadWrite.All |
HTTP request
PATCH /drives/{drive-id}/items/{item-id}
PATCH /groups/{group-id}/drive/items/{item-id}
PATCH /me/drive/items/{item-id}
PATCH /sites/{site-id}/drive/items/{item-id}
PATCH /users/{user-id}/drive/items/{item-id}
Optional request headers
Name | Type | Description |
---|---|---|
if-match | String | If this request header is included and the eTag (or cTag) provided doesn't match the current eTag on the folder, a 412 Precondition Failed response is returned. |
Request body
In the request body, supply the values for properties 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, your app shouldn't include properties that haven't changed.
Response
If successful, this method returns a 200 OK
response code and updated DriveItem resource in the response body.
Example
This example renames the DriveItem resource to "new-file-name.docx".
PATCH https://graph.microsoft.com/beta/me/drive/items/{item-id}
Content-type: application/json
{
"name": "new-file-name.docx"
}
Response
If successful, this method returns an driveItem resource in the response body.
HTTP/1.1 200 OK
Content-type: application/json
{
"id": "01NKDM7HMOJTVYMDOSXFDK2QJDXCDI3WUK",
"name": "new-file-name.docx",
"file": { }
}
Error responses
See Error Responses for details about how errors are returned.
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for