bookmarks.update()

bookmarks.update() updates the title and/or URL of a bookmark, or the name of a bookmark folder.

If the bookmark item could not be found, runtime.lastError is set, and you can check for it in the callback.

Syntax

chrome.bookmarks.update(
  id,                    // string
  changes,               // object
  function(              // optional function
    result                 // BookmarkTreeNode object
  ) {...}
)

This API is also available as browser.bookmarks.update() in a version that returns a promise.

Parameters

id

A string specifying the ID of the bookmark or bookmark folder to update.

changes

An object specifying the changes to apply, with some combination of the following fields. Any items not specified aren't changed in the referenced bookmark or folder:

title Optional

A string containing the new title of the bookmark, or the new name of the folder if id refers to a folder.

url Optional

A string providing a new URL for the bookmark.

callback Optional

A callback function which is called once the changes have been applied; it receives a single parameter:

result

A bookmarks.BookmarkTreeNode object representing the updated bookmark.

Browser compatibility

The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

Examples

Renaming folders

This example renames all folders named "MDN" to "Mozilla Developer Network (MDN)".

function updateFolders(items) {
  for (item of items) {
    // only folders, so skip items with a `url`
    if (!item.url) {
      chrome.bookmarks.update(item.id, {
        title: "Mozilla Developer Network (MDN)"
      });
    }
  }
}

chrome.bookmarks.search({ title: "MDN" }, updateFolders);

// Copyright 2015 The Chromium Authors. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//    * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//    * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//    * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.