Box Developer Documentation
Log in

A beta version of the new Box developer documentation site is launching soon! Updated Developer Guides, modern API Reference, and AI-powered search are on the way to help you build with Box faster. Stay tuned for more updates.

Latest version

Create web link

post
https://api.box.com/2.0
/web_links

This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.

Creates a web link object within a folder.

Related Guides

Request

bearer [ACCESS_TOKEN]
application/json

Request Body

stringin bodyoptional
"Cloud Content Management"

Description of the web link.

stringin bodyoptional
"Box Website"

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

objectin body

The parent folder to create the web link within.

stringin bodyrequired
"0"

The ID of parent folder.

stringin bodyrequired
"https://box.com"

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

Response

application/jsonWeb link

Returns the newly created web link object.

application/jsonClient error

An unexpected client error.

post
Create web link
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

Learn more about Box SDK versioning strategy.


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"
       }
     }'
Node/TypeScript v10
await client.webLinks.createWebLink({
  url: 'https://www.box.com',
  parent: { id: parent.id } satisfies CreateWebLinkRequestBodyParentField,
  name: getUuid(),
  description: 'Weblink description',
} satisfies CreateWebLinkRequestBody);
Python v10
client.web_links.create_web_link(
    "https://www.box.com",
    CreateWebLinkParent(id=parent.id),
    name=get_uuid(),
    description="Weblink description",
)
.NET v10
await client.WebLinks.CreateWebLinkAsync(requestBody: new CreateWebLinkRequestBody(url: "https://www.box.com", parent: new CreateWebLinkRequestBodyParentField(id: parent.Id)) { Name = Utils.GetUUID(), Description = "Weblink description" });
Swift v10
try await client.webLinks.createWebLink(requestBody: CreateWebLinkRequestBody(url: "https://www.box.com", parent: CreateWebLinkRequestBodyParentField(id: parent.id), name: Utils.getUUID(), description: "Weblink description"))
Java v10
client.getWebLinks().createWebLink(new CreateWebLinkRequestBody.Builder(url, new CreateWebLinkRequestBodyParentField(parent.getId())).name(name).description(description).build())
.NET v6
await client.WebLinks.CreateWebLinkAsync(requestBody: new CreateWebLinkRequestBody(url: "https://www.box.com", parent: new CreateWebLinkRequestBodyParentField(id: parent.Id)) { Name = Utils.GetUUID(), Description = "Weblink description" });
Node v4
await client.webLinks.createWebLink({
  url: 'https://www.box.com',
  parent: { id: parent.id } satisfies CreateWebLinkRequestBodyParentField,
  name: getUuid(),
  description: 'Weblink description',
} satisfies CreateWebLinkRequestBody);

Response Example

{
  "id": "11446498",
  "type": "web_link",
  "created_at": "2012-12-12T10:53:43-08:00",
  "created_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "description": "Example page",
  "etag": "1",
  "item_status": "active",
  "modified_at": "2012-12-12T10:53:43-08:00",
  "modified_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "name": "My Bookmark",
  "owned_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "parent": {
    "id": "12345",
    "type": "folder",
    "etag": "1",
    "name": "Contracts",
    "sequence_id": "3"
  },
  "path_collection": {
    "entries": [
      {
        "etag": "1",
        "id": "12345",
        "type": "folder",
        "name": "Contracts",
        "sequence_id": "3"
      }
    ],
    "total_count": 1
  },
  "purged_at": "2012-12-12T10:53:43-08:00",
  "sequence_id": "3",
  "shared_link": {
    "access": "open",
    "download_count": 3,
    "download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",
    "effective_access": "company",
    "effective_permission": "can_download",
    "is_password_enabled": true,
    "permissions": {
      "can_download": true,
      "can_edit": false,
      "can_preview": true
    },
    "preview_count": 3,
    "unshared_at": "2018-04-13T13:53:23-07:00",
    "url": "https://www.box.com/s/vspke7y05sb214wjokpk",
    "vanity_name": "my_url",
    "vanity_url": "https://acme.app.box.com/v/my_url/"
  },
  "trashed_at": "2012-12-12T10:53:43-08:00",
  "url": "https://www.example.com/example/1234"
}