Skip to main content

Web links are objects that point to URLs. These objects are also known as bookmarks within the Box web application.

Web link objects are treated similarly to file objects, they will also support most actions that apply to regular files.

id
string
required

The unique identifier for this web link.

Example:

"11446498"

type
enum<string>
required

The value will always be web_link.

Available options:
web_link
Example:

"web_link"

etag
string

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

Example:

"1"