Web link (Mini) - Box Dev Docs

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.

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"

url

string

The URL this web link points to.

Example:

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

sequence_id

string | null

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"

name

string

The name of the web link.

Example:

"My Bookmark"