Update DriveItem properties
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.
Permissions
One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.
Permission type | Permissions (from least to most privileged) |
---|---|
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 values for properties that should be updated.
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 your app should not 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 /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.