Skip to main content
POST
/
web_links
/
{web_link_id}
cURL
curl -i -X POST "https://api.box.com/2.0/web_links/12345" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
{
  "sequence_id": "3",
  "path_collection": {
    "total_count": 1,
    "entries": [
      {
        "id": "12345",
        "type": "folder",
        "etag": "1",
        "sequence_id": "3",
        "name": "Contracts"
      }
    ]
  },
  "type": "web_link",
  "id": "11446498",
  "etag": "1",
  "name": "My Bookmark",
  "url": "https://www.example.com/example/1234",
  "parent": {
    "id": "12345",
    "type": "folder",
    "etag": "1",
    "sequence_id": "3",
    "name": "Contracts"
  },
  "description": "Example page",
  "created_at": "2012-12-12T10:53:43-08:00",
  "modified_at": "2012-12-12T10:53:43-08:00",
  "trashed_at": null,
  "purged_at": null,
  "created_by": {
    "id": "11446498",
    "type": "user",
    "name": "Aaron Levie",
    "login": "[email protected]"
  },
  "modified_by": {
    "id": "11446498",
    "type": "user",
    "name": "Aaron Levie",
    "login": "[email protected]"
  },
  "owned_by": {
    "id": "11446498",
    "type": "user",
    "name": "Aaron Levie",
    "login": "[email protected]"
  },
  "shared_link": null,
  "item_status": "trashed"
}
This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.Learn more about Box SDK versioning strategy.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
web_link_id
string
required

The ID of the web link.

Query Parameters

​
fields
string[]

A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.

Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

Body

application/json
​
name
string

An optional new name for the web link.

Example:

"Restored.docx"

​
parent
object

Specifies an optional ID of a folder to restore the web link to when the original folder no longer exists.

Please be aware that this ID will only be used if the original folder no longer exists. Use this ID to provide a fallback location to restore the web link to if the original location has been deleted.

Response

Returns a web link object when it has been restored.

Represents a web link restored from the trash.

​
sequence_id
string | null
required

A numeric identifier that represents the most recent user event that has been applied to this item.

This can be used in combination with the GET /events-endpoint to filter out user events that would have occurred before this identifier was read.

An example would be where a Box Drive-like application would fetch an item via the API, and then listen to incoming user events for changes to the item. The application would ignore any user events where the sequence_id in the event is smaller than or equal to the sequence_id in the originally fetched resource.

Example:

"3"

​
path_collection
Path collection · object
required

The tree of folders that this web link is contained in, starting at the root.

​
type
enum<string>

The value will always be web_link.

Available options:
web_link
Example:

"web_link"

​
id
string

The unique identifier for this web link.

Example:

"11446498"

​
etag
string

The entity tag of this web link. Used with If-Match headers.

Example:

"1"

​
name
string

The name of the web link.

Example:

"My Bookmark"

​
url
string

The URL this web link points to.

Example:

"https://www.example.com/example/1234"

​
parent
Folder (Mini) · object

The parent object the web link belongs to.

​
description
string

The description accompanying the web link. This is visible within the Box web application.

Example:

"Example page"

​
created_at
string<date-time>

When this file was created on Box’s servers.

Example:

"2012-12-12T10:53:43-08:00"

​
modified_at
string<date-time>

When this file was last updated on the Box servers.

Example:

"2012-12-12T10:53:43-08:00"

​
trashed_at
string | null

The time at which this bookmark was put in the trash - becomes null after restore.

Example:

null

​
purged_at
string | null

The time at which this bookmark will be permanently deleted - becomes null after restore.

Example:

null

​
created_by
User (Mini) · object

The user who created this web link.

​
modified_by
User (Mini) · object

The user who last modified this web link.

​
owned_by
User (Mini) · object

The user who owns this web link.

​
shared_link
string | null

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.

Example:

null

​
item_status
enum<string>

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.

Available options:
active,
trashed,
deleted
Example:

"trashed"