Join BoxWorks 2024 to discover what's possible with content and AI!
Register now!Remove shared link from file
Removes a shared link from a file.
Request
Path Parameters
12345The unique identifier that represents a file.
The ID for any file can be determined
by visiting a file in the web application
and copying the ID from the URL. For example,
for the URL https://*.app.box.com/files/123
the file_id is 123.
Query Parameters
shared_linkExplicitly request the shared_link fields
to be returned for this item.
Request Body
Response
Returns a basic representation of a file, with the shared link removed.
Returned when the access token provided in the Authorization header
is not recognized or not provided.
Returned if the user does not have all the permissions to complete the update.
Returned if the file is not found, or the user does not have access to the file.
Returned if the file_id is not in a recognized format.
Returns an error when the If-Match header does not match
the current etag value of the file. This indicates that the file
has changed since it was last requested.
An unexpected client error.
Request Example
curl -i -X PUT "https://api.box.com/2.0/files/32423234?fields=shared_link" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-d '{
"shared_link": null
}'BoxFile file = new BoxFile(api, "12345");
BoxFile.Info info = file.getInfo();
info.removeSharedLink();
file.updateInfo(info);file_id = '11111'
client.file(file_id).remove_shared_link()client.files.update('12345', {
shared_link: null
}).then(file => {
// ...
})client.files.deleteSharedLink(fileId: "11111") { (result: Result<Void, BoxSDKError>) in
guard case .success = result else {
print("Error removing file shared link")
return
}
print("File shared link removed")
}Response Example
{
"id": "12345",
"type": "file",
"etag": "1",
"shared_link": null
}