Box Developer Documentation

Join BoxWorks 2024 to discover what's possible with content and AI!

Register now!

Remove shared link from web link

put
https://api.box.com/2.0
/web_links/:web_link_id

Removes a shared link from a web link.

Request

bearer [ACCESS_TOKEN]
application/json

Path Parameters

Query Parameters

stringin queryrequired
shared_link

Explicitly request the shared_link fields to be returned for this item.

Request Body

Response

application/jsonWeb link

Returns a basic representation of a web link, with the shared link removed.

application/jsonClient error

Returned when the access token provided in the Authorization header is not recognized or not provided.

application/jsonClient error

Returned if the user does not have all the permissions to complete the update.

application/jsonClient error

Returned if the file is not found, or the user does not have access to the file.

application/jsonClient error

Returned if the file_id is not in a recognized format.

application/jsonClient error

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.

application/jsonClient error

An unexpected client error.

put
Remove shared link from web link
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

cURL
curl -i -X PUT "https://api.box.com/2.0/web_links/32423234?fields=shared_link" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -d '{
       "shared_link": null
     }'
Python
client.web_link('12345').remove_shared_link()
.NET
BoxWebLink updatedLink = client.WebLinksManager.DeleteSharedLinkAsync("11111");
iOS
client.webLinks.deleteSharedLink(forWebLink: "11111") { (result: Result<Void, BoxSDKError>) in
    guard case .success = result else {
        print("Error removing weblink shared link")
        return
    }

    print("WebLink shared link removed")
}

Response Example

{
  "id": "12345",
  "type": "web_link",
  "etag": "1",
  "shared_link": null
}