Join BoxWorks 2024 to discover what's possible with content and AI!
Register now!Updates a shared link on a web link.
12345
The ID of the web link.
shared_link
Explicitly request the shared_link
fields
to be returned for this item.
Returns a basic representation of the web link, with the updated shared link attached.
Returned when there is an incorrect permission combination
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.
curl -i -X PUT "https://api.box.com/2.0/web_links/32423234?fields=shared_link" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-d '{
"shared_link": {
"access": "open",
"password": "mypassword",
"unshared_at": "2012-12-12T10:53:43-08:00",
"permissions": {
"can_download": false
}
}
}'
url = client.web_link('12345').get_shared_link(access='open', password='letmein')
print(f'The web link shared link URL is: {url}')
{
"id": "12345",
"type": "web_link",
"etag": "1",
"shared_link": {
"url": "https://app.box.com/s/kwio6b4ovt1264rnfbyqo1",
"download_url": "https://app.box.com/shared/static/kwio6b4ovt1264rnfbyqo1.pdf",
"vanity_url": null,
"vanity_name": null,
"effective_access": "open",
"effective_permission": "can_download",
"is_password_enabled": false,
"unshared_at": "2020-09-21T10:34:41-07:00",
"download_count": 0,
"preview_count": 0,
"access": "open",
"permissions": {
"can_preview": true,
"can_download": true,
"can_edit": false
}
}
}