Create bookmark

Namespace: microsoft.graph.search

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Create a new bookmark object.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type Permissions (from least to most privileged)
Delegated (work or school account) SearchConfiguration.Read.All, SearchConfiguration.ReadWrite.All
Delegated (personal Microsoft account) Not supported.
Application SearchConfiguration.Read.All, SearchConfiguration.ReadWrite.All

HTTP request

POST /search/bookmarks

Request headers

Name Description
Authorization Bearer {token}. Required.
Content-Type application/json. Required.

Request body

In the request body, supply a JSON representation of the bookmark object.

The following table shows the properties that are available when you create a bookmark.

Property Type Description
displayName String Bookmark name displayed in search results. Inherited from searchAnswer.
description String Bookmark description shown on search results page. Inherited from searchAnswer.
webUrl String Bookmark URL link. When users click this bookmark in search results, they will go to this URL. Inherited from searchAnswer.
categories String collection Categories commonly used to describe this bookmark. For example, IT and HR.
availabilityStartDateTime DateTimeOffset Timestamp of when the bookmark will start to appear as a search result. Set as null for always available.
availabilityEndDateTime DateTimeOffset Timestamp of when the bookmark will stop to appear as a search result. Set as null for always available.
languageTags String collection List of countries or regions able to view this bookmark.
platforms microsoft.graph.devicePlatformType collection List of devices and operating systems able to view this bookmark. Possible values are: unknown, android, androidForWork, ios, macOS, windowsPhone81, windowsPhone81AndLater, windows10AndLater, androidWorkProfile, androidASOP.
targetedVariations microsoft.graph.search.answerVariant collection Variations of a bookmark for different countries or devices. Use when you need to show different content to users based on their device, country/region, or both. The date and group settings will apply to all variations.
powerAppIds String collection List of Power Apps associated with this bookmark. If users add existing Power Apps to a bookmark, they can complete tasks, such as to enter vacation time or to report expenses on the search results page.
keywords microsoft.graph.search.answerKeyword Keywords that trigger this bookmark to appear in search results.
state microsoft.graph.search.answerState State of the bookmark. Possible values are: published, draft, excluded, or unknownFutureValue.
groupIds String collection List of security groups able to view this bookmark.

Response

If successful, this method returns a 201 Created response code with the ID of the bookmark created.

Examples

Request

POST https://graph.microsoft.com/beta/search/bookmarks
Content-Type: application/json

{
  "displayName": "Contoso Install Site",
  "webUrl": "http://www.contoso.com/",
  "description": "Try or buy Contoso for Home or Business and view product information",
  "keywords":  {
    "keywords": ["Contoso", "install"],
    "reservedKeywords": ["Contoso"],
    "matchSimilarKeywords": true
  },
  "availabilityStartDateTime": null,
  "availabilityEndDateTime": null,
  "platforms": ["windows"],
  "targetedVariations": [
    {
      "languageTag": "es-es",
      "displayName": "Sitio de instalación Contoso",
      "description": "Pruebe o compre Contoso hogar o negocios y vea la información del producto"
    }
  ],
  "state": "published"
}

Response

Here is an example of the response.

HTTP/1.1 201 CREATED
Location: /733b26d5-af76-4eea-ac69-1a0ce8716897
Content-Type: application/json

{
  "id": "733b26d5-af76-4eea-ac69-1a0ce8716897"
}