Skip to main content
POST
/
web_links
cURL
curl -i -X POST "https://api.box.com/2.0/web_links" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H "content-type: application/json" \
     -d '{
       "name": "Cloud Content Management",
       "url": "https://box.com",
       "parent": {
         "id": "0"
       }
     }'
{
  "id": "11446498",
  "type": "web_link",
  "etag": "1",
  "url": "https://www.example.com/example/1234",
  "sequence_id": "3",
  "name": "My Bookmark",
  "parent": {
    "id": "12345",
    "type": "folder",
    "etag": "1",
    "sequence_id": "3",
    "name": "Contracts"
  },
  "description": "Example page",
  "path_collection": {
    "total_count": 1,
    "entries": [
      {
        "id": "12345",
        "type": "folder",
        "etag": "1",
        "sequence_id": "3",
        "name": "Contracts"
      }
    ]
  },
  "created_at": "2012-12-12T10:53:43-08:00",
  "modified_at": "2012-12-12T10:53:43-08:00",
  "trashed_at": "2012-12-12T10:53:43-08:00",
  "purged_at": "2012-12-12T10:53:43-08:00",
  "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": {
    "url": "https://www.box.com/s/vspke7y05sb214wjokpk",
    "effective_access": "company",
    "effective_permission": "can_download",
    "is_password_enabled": true,
    "download_count": 3,
    "preview_count": 3,
    "download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",
    "vanity_url": "https://acme.app.box.com/v/my_url/",
    "vanity_name": "my_url",
    "access": "open",
    "unshared_at": "2018-04-13T13:53:23-07:00",
    "permissions": {
      "can_download": true,
      "can_preview": true,
      "can_edit": false
    }
  },
  "item_status": "active"
}
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.

Body

application/json
​
url
string
required

The URL that this web link links to. Must start with "http://" or "https://".

Example:

"https://box.com"

​
parent
object
required

The parent folder to create the web link within.

​
name
string

Name of the web link. Defaults to the URL if not set.

Example:

"Box Website"

​
description
string

Description of the web link.

Example:

"Cloud Content Management"

Response

Returns the newly created web link object.

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"

​
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"

​
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"

​
path_collection
Path collection · object

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

​
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<date-time> | null

When this file was moved to the trash.

Example:

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

​
purged_at
string<date-time> | null

When this file will be permanently deleted.

Example:

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

​
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
Shared link · object

The shared link object for this item. Will be null if no shared link has been created.

​
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:

"active"