Updates a web link object.
12345
The ID of the web link.
"Cloud Content Management"
A new description of the web link.
"Box Website"
A new name for the web link. Defaults to the URL if not set.
The new parent folder to put the web link in. Use this to move the web link to a different folder.
"123"
The ID of parent item
"https://box.com"
The new URL that the web link links to. Must start with
"http://"
or "https://"
.
Returns the updated web link object.
An unexpected client error.
curl -i -X PUT "https://api.box.com/2.0/web_links/12345" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-H "content-type: application/json" \
-d '{
"name": "Cloud Content Management"
}'
await client.webLinks.updateWebLinkById(weblink.id, {
requestBody: {
name: updatedName,
sharedLink: {
access: 'open' as UpdateWebLinkByIdRequestBodySharedLinkAccessField,
password: password,
} satisfies UpdateWebLinkByIdRequestBodySharedLinkField,
} satisfies UpdateWebLinkByIdRequestBody,
} satisfies UpdateWebLinkByIdOptionalsInput);
client.web_links.update_web_link_by_id(
weblink.id,
name=updated_name,
shared_link=UpdateWebLinkByIdSharedLink(
access=UpdateWebLinkByIdSharedLinkAccessField.OPEN, password=password
),
)
await client.WebLinks.UpdateWebLinkByIdAsync(webLinkId: weblink.Id, requestBody: new UpdateWebLinkByIdRequestBody() { Name = updatedName, SharedLink = new UpdateWebLinkByIdRequestBodySharedLinkField() { Access = UpdateWebLinkByIdRequestBodySharedLinkAccessField.Open, Password = password } });
BoxWebLink webLink = new BoxWebLink(api, id);
BoxWebLink.Info webLinkInfo = webLink.new Info();
webLinkInfo.setName("new name for weblink");
webLink.updateInfo(webLinkInfo);
var updates = new BoxWebLinkRequest()
{
Name = "New Name for Weblink"
};
BoxWebLink updatedLink = await client.WebLinksManager.UpdateWebLinkAsync("11111", updates);
client.weblinks.update(
'11111',
{
name: 'Box Marketing Site',
description: 'First page that customers land on'
})
.then(weblink => {
/* weblink -> {
type: 'web_link',
id: '11111',
sequence_id: '0',
etag: '0',
name: 'Box Marketing Site',
url: 'https://www.box.com',
created_by:
{ type: 'user',
id: '33333',
name: 'Example User',
login: 'user@example.com' },
created_at: '2015-05-07T15:00:01-07:00',
modified_at: '2017-06-13T12:34:51-07:00',
parent:
{ type: 'folder',
id: '22222',
sequence_id: '1',
etag: '1',
name: 'Bookmarks' },
description: 'First page that customers land on',
item_status: 'active',
trashed_at: null,
purged_at: null,
shared_link: null,
path_collection:
{ total_count: 2,
entries:
[ { type: 'folder',
id: '0',
sequence_id: null,
etag: null,
name: 'All Files' },
{ type: 'folder',
id: '22222',
sequence_id: '1',
etag: '1',
name: 'Bookmarks' } ] },
modified_by:
{ type: 'user',
id: '33333',
name: 'Example User',
login: 'user@example.com' },
owned_by:
{ type: 'user',
id: '33333',
name: 'Example User',
login: 'user@example.com' } }
*/
});
client.webLinks.update(webLinkId: "11111", name: "new name for weblink") { (result: Result<WebLink, BoxSDKError>) in
guard case let .success(webLink) = result else {
print("Error updating web link information")
return
}
print("WebLink \(webLink.name) was updated successfully")
}
{
"id": "11446498",
"type": "web_link",
"created_at": "2012-12-12T10:53:43-08:00",
"created_by": {
"id": "11446498",
"type": "user",
"login": "ceo@example.com",
"name": "Aaron Levie"
},
"description": "Example page",
"etag": "1",
"item_status": "active",
"modified_at": "2012-12-12T10:53:43-08:00",
"modified_by": {
"id": "11446498",
"type": "user",
"login": "ceo@example.com",
"name": "Aaron Levie"
},
"name": "My Bookmark",
"owned_by": {
"id": "11446498",
"type": "user",
"login": "ceo@example.com",
"name": "Aaron Levie"
},
"parent": {
"id": "12345",
"type": "folder",
"etag": "1",
"name": "Contracts",
"sequence_id": "3"
},
"path_collection": {
"entries": [
{
"etag": "1",
"id": "12345",
"type": "folder",
"name": "Contracts",
"sequence_id": "3"
}
],
"total_count": 1
},
"purged_at": "2012-12-12T10:53:43-08:00",
"sequence_id": "3",
"shared_link": {
"access": "open",
"download_count": 3,
"download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",
"effective_access": "company",
"effective_permission": "can_download",
"is_password_enabled": true,
"permissions": {
"can_download": true,
"can_edit": false,
"can_preview": true
},
"preview_count": 3,
"unshared_at": "2018-04-13T13:53:23-07:00",
"url": "https://www.box.com/s/vspke7y05sb214wjokpk",
"vanity_name": "my_url",
"vanity_url": "https://acme.app.box.com/v/my_url/"
},
"trashed_at": "2012-12-12T10:53:43-08:00",
"url": "https://www.example.com/example/1234"
}