Move a DriveItem to a new folder
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.
To move a DriveItem to a new parent item, your app requests to update the parentReference of the DriveItem to move.
This is a special case of the Update method. Your app can combine moving an item to a new container and updating other properties of the item into a single request.
Items cannot be moved between Drives using this request.
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 does not match the current eTag on the folder, a 412 Precondition Failed response is returned. |
Request body
In the request body, supply the new value for the parentReference property. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed.
Note: When moving items to the root of a drive your app cannot use the "id:" "root"
syntax.
Your app needs to provide the actual ID of the root folder for the parent reference.
Response
If successful, this method returns a 200 OK
response code and updated DriveItem resource in the response body.
Example
This example moves an item specified by {item-id} into a folder in the user's drive with the ID new-parent-folder-id
.
PATCH https://graph.microsoft.com/beta/me/drive/items/{item-id}
Content-type: application/json
{
"parentReference": {
"id": "new-parent-folder-id"
},
"name": "new-item-name.txt"
}
Response
The following example shows the response for this move request.
HTTP/1.1 200 OK
Content-type: application/json
{
"id": "0123456789abc",
"name": "new-item-name.txt",
"parentReference":
{
"driveId": "11231001",
"path": "/drive/root:/Documents",
"id": "1231203102!1011"
}
}
Error responses
See Error Responses for more info 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