Box Developer Documentation
Log in
Latest version

Remove shared link from web link

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

This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.

Removes a shared link from a web link.

Request

bearer [ACCESS_TOKEN]
application/json

Path Parameters

stringin pathrequired
12345

The ID of the web link.

Query Parameters

stringin queryrequired
shared_link

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

Request Body

objectin body
null

By setting this value to null, the shared link is removed from the web link.

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

Learn more about Box SDK versioning strategy.


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
     }'
Node/TypeScript v10
await client.sharedLinksWebLinks.removeSharedLinkFromWebLink(
  webLinkId,
  { sharedLink: createNull() } satisfies RemoveSharedLinkFromWebLinkRequestBody,
  { fields: 'shared_link' } satisfies RemoveSharedLinkFromWebLinkQueryParams,
);
Python v10
client.shared_links_web_links.remove_shared_link_from_web_link(
    web_link_id, "shared_link", shared_link=create_null()
)
.NET v10
await client.SharedLinksWebLinks.RemoveSharedLinkFromWebLinkAsync(webLinkId: webLinkId, requestBody: new RemoveSharedLinkFromWebLinkRequestBody() { SharedLink = null }, queryParams: new RemoveSharedLinkFromWebLinkQueryParams(fields: "shared_link"));
Java v10
client.getSharedLinksWebLinks().removeSharedLinkFromWebLink(webLinkId, new RemoveSharedLinkFromWebLinkRequestBody.Builder().sharedLink(null).build(), new RemoveSharedLinkFromWebLinkQueryParams("shared_link"))
Python v4
client.web_link('12345').remove_shared_link()
.NET v6
BoxWebLink updatedLink = client.WebLinksManager.DeleteSharedLinkAsync("11111");

Response Example

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