Sample - Box Platform API
POST/web_links/{web_link_id}

Restore a web link

Restores a web link that has been moved to the trash. Supply web_link_id and optionally provide a new name or fallback parent folder when the original folder no longer exists. Use fields to control which attributes appear in the restored web link representation.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters · 2 body fields
web_link_idstringrequired
The unique identifier of the web link to restore.
fieldsarray<string>optional
A comma-separated list of attributes to include in the response; specifying it replaces the standard fields with the requested fields and the mini representation.

Optional replacement name and destination information for the restored web link.

namestringoptional
An optional new name for the web link.
parentobjectoptional
An optional parent folder for the restored web link, used as a fallback when the original folder no longer exists.

5 status codes
201Returns the restored web link object.
typestringoptional
The value will always be `web_link`.
Allowed:web_link
idstringoptional
The unique identifier for this web link.
sequence_idobjectrequired
etagstringoptional
The entity tag of this web link. Used with `If-Match` headers.
namestringoptional
The name of the web link.
urlstringoptional
The URL this web link points to.
parentobjectoptional
descriptionstringoptional
The description accompanying the web link. This is visible within the Box web application.
path_collectionobjectrequired
created_atstringoptional
When this file was created on Box’s servers.
modified_atstringoptional
When this file was last updated on the Box servers.
trashed_atstringoptional
The time at which this bookmark was put in the trash - becomes `null` after restore.
purged_atstringoptional
The time at which this bookmark will be permanently deleted - becomes `null` after restore.
created_byobjectoptional
modified_byobjectoptional
owned_byobjectoptional
shared_linkstringoptional
The shared link for this bookmark. This will be `null` if a bookmark had been trashed, even though the original shared link does become active again.
item_statusstringoptional
Whether this item is deleted or not. Values include `active`, `trashed` if the file has been moved to the trash, and `deleted` if the file has been permanently deleted.
Allowed:activetrasheddeleted
403Returned when the authenticated user cannot access the destination folder or lacks permission to restore the web link from the trash.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.
404Returned when the web link is not in the trash.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.
409Returned when another web link with the same name already exists in the destination folder.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.
defaultAn unexpected client error.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.

Error handling

A 403 is returned when the authenticated user cannot access the destination folder or lacks permission to restore the web link. A 404 is returned when the web link is not in the trash, and a 409 is returned when another web link with the same name already exists in the destination folder. fields accepts a comma-separated list of response attributes.