Box Developer Documentation
 
    Latest version

    Update web link

    put
    https://api.box.com/2.0
    /web_links/:web_link_id

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

    Updates a web link object.

    Request

    bearer [ACCESS_TOKEN]
    application/json

    Path Parameters

    Request Body

    stringin bodyoptional
    "Cloud Content Management"

    A new description of the web link.

    stringin bodyoptional
    "Box Website"

    A new name for the web link. Defaults to the URL if not set.

    objectin body

    The new parent folder to put the web link in. Use this to move the web link to a different folder.

    stringin bodyoptional
    "123"

    The ID of parent item

    stringin bodyoptional
    "12346930"

    The input for user_id is optional. Moving to non-root folder is not allowed when user_id is present. Parent folder id should be zero when user_id is provided.

    stringin bodyoptional
    "https://box.com"

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

    Response

    application/jsonWeb link

    Returns the updated web link object.

    application/jsonClient error

    An unexpected client error.

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

    Request Example

    cURL
    curl -i -X PUT "https://api.box.com/2.0/web_links/12345" \
         -H "authorization: Bearer <ACCESS_TOKEN>" \
         -H "content-type: application/json" \
         -d '{
           "name": "Cloud Content Management"
         }'

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