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