Manage Applications

    Create web link

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

    Creates a web link object within a folder.

    Request

    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.

    Parentin body

    The parent folder to put the web link in

    stringin bodyoptional
    123

    The ID of parent item

    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.

    You can now try out some of our APIs live, right here in the documentation.
    Log In

    Request Example

    cURL
    curl -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"
         }'
    .NET
    var weblinkParams = new BoxWebLinkRequest()
    {
        Url = new Uri("http://www.example.com"),
        Parent = new BoxRequestEntity()
        {
            Id = "22222"
        }
    };
    BoxWebLink link = await client.WebLinksManager.CreateWebLinkAsync(weblinkParams);
    Java
    BoxFolder folder = new BoxFolder(api, id);
    URL url = new URL("https://www.example.com");
    folder.createWebLink("Link to Example", url, "This goes to an example page");
    Python
    web_link = client.folder(folder_id='12345').create_web_link('https://example.com', 'Example Link', 'This is the description')
    print('Web Link url is {0} and its description is {1}'.format(web_link.url, web_link.description))
    Node
    client.weblinks.create(
    	'https://www.box.com',
    	'22222',
    	{
    		name: 'Box Website!',
    		description: 'Cloud Content Management'
    	})
    	.then(weblink => {
    		/* weblink -> {
    			type: 'web_link',
    			id: '11111',
    			sequence_id: '0',
    			etag: '0',
    			name: 'Box Website!',
    			url: 'https://www.box.com',
    			created_by: 
    			{ type: 'user',
    				id: '33333',
    				name: 'Example User',
    				login: 'user@example.com' },
    			created_at: '2015-05-07T15:00:01-07:00',
    			modified_at: '2015-05-07T15:00:01-07:00',
    			parent: 
    			{ type: 'folder',
    				id: '22222',
    				sequence_id: '1',
    				etag: '1',
    				name: 'Bookmarks' },
    			description: 'Enterprise Cloud Content Management',
    			item_status: 'active',
    			trashed_at: null,
    			purged_at: null,
    			shared_link: null,
    			path_collection: 
    			{ total_count: 2,
    				entries: 
    				[ { type: 'folder',
    					id: '0',
    					sequence_id: null,
    					etag: null,
    					name: 'All Files' },
    					{ type: 'folder',
    					id: '22222',
    					sequence_id: '1',
    					etag: '1',
    					name: 'Bookmarks' } ] },
    			modified_by: 
    			{ type: 'user',
    				id: '33333',
    				name: 'Example User',
    				login: 'user@example.com' },
    			owned_by: 
    			{ type: 'user',
    				id: '33333',
    				name: 'Example User',
    				login: 'user@example.com' } }
    		*/
    	});

    Response Example

    {
      "id": 11446498,
      "type": "web_link",
      "sequence_id": 3,
      "etag": 1,
      "name": "My Bookmark",
      "url": "https://www.example.com/example/1234",
      "parent": {
        "id": 12345,
        "etag": 1,
        "type": "folder",
        "sequence_id": 3,
        "name": "Contracts"
      },
      "description": "Example page",
      "path_collection": [
        {
          "id": 12345,
          "etag": 1,
          "type": "folder",
          "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": "ceo@example.com"
      },
      "modified_by": {
        "id": 11446498,
        "type": "user",
        "name": "Aaron Levie",
        "login": "ceo@example.com"
      },
      "owned_by": {
        "id": 11446498,
        "type": "user",
        "name": "Aaron Levie",
        "login": "ceo@example.com"
      },
      "shared_link": {
        "url": "https://www.box.com/s/vspke7y05sb214wjokpk",
        "download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",
        "vanity_url": "https://acme.app.box.com/v/my_url/",
        "access": "open",
        "effective_access": "company",
        "effective_permission": "can_download",
        "unshared_at": "2018-04-13T13:53:23-07:00",
        "is_password_enabled": true,
        "permissions": {
          "can_download": true,
          "can_preview": true
        },
        "download_count": 3,
        "preview_count": 3
      },
      "item_status": "active"
    }