bookmarks.create()

Creates a bookmark or folder as a child of the BookmarkTreeNode with the specified parentId. To create a folder, omit or leave empty the CreateDetails.url parameter.

This is an asynchronous function that returns a Promise.

Syntax

var createBookmark = browser.bookmarks.create(
  bookmark                  // CreateDetails object
)

Parameters

bookmark

An object containing some combination of the following fields:

parentId Optional
A string which indicates the parent folder into which to place the new bookmark or bookmark folder. Each browser has its own default; on Chrome, the default is the "Other Bookmarks" folder. On Firefox, the default is "Unfiled Bookmarks".
index Optional
An integer Number which specifies the position at which to place the new bookmark under its parent. A value of 0 will put it at the top of the list.
title Optional
A string which specifies the title for the bookmark or the name of the folder to be created. If this isn't specified, the title is "".
url Optional
string. A string which specifies the URL of the page to bookmark. If this is omitted or is null, a folder is created instead of a bookmark.

Return value

A Promise that will be fulfilled with a BookmarkTreeNode that describes the new bookmark node.

Browser compatibility

Chrome Edge Firefox Firefox for Android Opera
Basic support Yes No 45.0 No 33

Examples

This example creates a bookmark for this page, placing it in the default folder ("Unfiled Bookmarks" in Firefox, "Other Bookmarks" in Chrome).

function onCreated(node) {
  console.log(node);
}

var createBookmark = browser.bookmarks.create({
  title: "bookmarks.create() on MDN",
  url: "https://developer.mozilla.org/Add-ons/WebExtensions/API/bookmarks/create"
});

createBookmark.then(onCreated);

Example add-ons

Acknowledgements

This API is based on Chromium's chrome.bookmarks API. This documentation is derived from bookmarks.json in the Chromium code.

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.

Document Tags and Contributors

 Contributors to this page: wbamberg, Makyen, Sheppy
 Last updated by: wbamberg,