How to clear annoying Excel file locks in Power Automate
I was recently working on a project where I needed to use Power Automate to upload an Excel file to SharePoint, crack it open to get to the goodies inside and then delete the file.
Getting to the file contents is straightforward enough using the Excel connector, but the really annoying thing is the file sharing lock the Excel connector then places on a file which typically results in an angry red dot of failure when using the SharePoint delete file action:
The file https://company.sharepoint.com/teams/path/to/file.xlsx is locked for shared use by paul@company.com [membership]. clientRequestId: blah serviceRequestId: blah;blah
I am sure many folks have hit this and might put a wait in their flow or write a scheduled flow to cleanup later when the lock has expired.
But did you know that we can easily bypass this issue and delete this locked file? All we need to do is use the very versatile swiss army knife action known as “Send an HTTP request to SharePoint” to call the API that handles recycling of files. We then add a directive to the header of the request that essentially says “I don’t care about your stupid lock, delete anyway!”
Here is what the API call looks like:
_api/web/Lists/GetByTitle('DocLib')/GetItemById(ID)/recycle
The extra magic is in the header:
Prefer: bypass-shared-lock
So the entire request looks like this:
Thanks for reading
Paul
This one has been driving me nuts and all I was able to find online were solutions to loop until SP automatically unlocked the file. Your solution was WAY simpler and more elegant. Thank you for posting!
I am not able to set the API call for ‘Send an HTTP request to SharePoint’ action. I have added my document library (hardcoded) and ID (dynamic content) from the file creation action. But, I am getting error that the expression is invalid. Please help.
Awesome info!!!!! Do you have a solution if I’m using OneDrive instead of SharePoint?
Hi Team,
If anyone can say me how to get that URI part, it will be very helpful and appreciated, Im new to power automate please please help me out this is the main task i have to do it.
Hi Team,
Can you please say what should i put in URI please.
Thanks in advance.
Hi,
I used the DELETE method instead of POST , and also a different URI
_api/web/GetFileByServerRelativeUrl(‘/sites/YoursiteName/Shared Documents/General/YourFileName’)
This work for me 😉
It works completely well thank yoiu for the assist
The /recycle seems to be deleting the file regardless of the lock. I really just want to clear the lock so I can continue on to the next step of using the file. Is this at all possible?
Wow you saved me and everyone. It was the last part of the project and 1 day prior to the release when i hit this road block. Savior. Thank you
Thank you for this. Helped a lot 🙂
How did you get the sharepoint ID in the uri ?
in my case is upload file/ create File. can this be solved with a send and https request?
This works for me.
But then I tried to imitate this method to move the file
_api/web/Lists/GetByTitle(‘Documents’)/GetItemById(ID)/moveTo(newurl=’https://example.sharepoint.com/Documents/book1.xlsx’, flags=1)
and it always says Cannot find resource for the request moveTo.
Does anyone know how to deal with this error?
wow, this has plagued me and many other users for years! It worked! Would you be ok with me posting this solution in the Power Automate Power Users forum? I did not see it there previously. I would put a link to this article and give you credit. Amazing!
Thanks for this!
As with @Pavankumar Patil above, I am also creating a temporary file that needs deleted and found that the “ID” attribute is not correct, the “ItemId” attribute must be used. Also if you are deleting from the default Shared Documents list, the list is called “Documents”.
What can I say, life saver! Ms really should include a “force”checkbox in the delete action
A similar problem is encountered when a user created a new document within a Document Library, and a PowerAutomate Flow has been set to “Update New File Properties” of that file, say, patching in file meta-data. If the user has the file open (or if it’s closed, but the SharePoint still has it marked as locked) then the flow will fail.
Popular workarounds include a Check-if-document-is-still-locked Do Until loop, but this becomes problematic when SharePoint fails to unlock a file after the user is no longer in the file.
Is there a similar method that may be called to allow both the User to be editing their new file, and also have a Flow patch in New File Properties at the same time?
This works – and much cleaner than a wait loop! However, is there any way of executing WITHOUT immediately deleting? My task is to MOVE the file and then delete it, but need to clear the lock first… I cannot find an alternate qualifier to /recycle that unlocks but leaves the file. Is there
Hi,
Am I the only one that the solution doesn’t work ? It’s written that the API doesn’t exist
Vincent
Using the DELETE method instead of POST worked for me as well as using the below:
_api/web/GetFileByServerRelativeUrl(‘{everythingAfterTheDomainUpToTheFilename}/ {filenameWithExtension}’)
Great help, thank you.
I think I had the same issue others reported in the comments.
I found I was not getting the ID properly.
List files will not work, I switched to Get Files (properties only) and the ID from that worked
Hi Paul,
First of all, thanks for sharing.
I did exactly all steps above, but what is happening is, the action (Send HTTP POST or DELETE) is running perfectly but the files are always being moved to the Recycle Bin.
I thought they would stay in the same folder and be unlocked.
Do you have any idea what might be happening?
Cheers
Ricardo.
Hi, thank you so much for the help.
Where you have, ‘DocLib’, for me will that be something like,
‘Shared%20Documents/Event%20Manager%20Reports/Completed%20Reports’
i.e. the path to the file?
Thank you, Guy
This is great but I’ve come to the conclusion that the power platform is severely limited and the simplest things cannot be done. When you can copy a file but can’t choice its file name you know its not worth taking it seriously.
Good to know and thanks for sharing, as others have asked above is there an API that allows for unlocking but also retains the file rather than deleting it? 6 mins plus wait for a file to unlock is just not workable.
Using getItemById I got a 401 error. Even though user is sc admin.
But using _api/web/GetFileByServerRelativeUrl and DELETE instead works fine and deletes the damned excel file.
Thanks for sharing, Paul.
Thanks a lot for giving me this idea, it took some time to make it work with my files.
but I wish I knew this before.
Appreciate your help.
Thanks for the help – you saved me the time it would have taken to make these loops
This took way longer than it should have, but I figured it out!
I ended up using the _api/web/GetFileByServerRelativeUrl with a DELETE method.
Here’s my URI:
_api/web/GetFileByServerRelativeUrl(‘/sites/mysitename/Shared documents/fileNameWithextension’)
Please be weary copy-pasting from these examples, as the string delimiter -> ‘ ‘, not the paragraph character -> ` , that they are using. 🙂
What if…. I don’t want to *delete* the file but just to *unlock* it? I have a Flow which updates a row in an Excel Table and I want to be able to copy the file after that – but it’s locked out at random times for random periods of time.
I am not sure how this is supposed to work or how the author is making it work.
But the URI clearly states that this is for “Lists” and not document libraries.
This is the reason why so many people in the comments have more success with the “Delete” api call and “GetFileByServerRelativeUrl”
Not sure what the author is doing exactly.
I have the same question:
Do you have a solution if I’m using OneDrive instead of SharePoint?
Thank you
Is there a way where we can only remove the lock on file and not delete it ?