Update bookmark

Namespace: microsoft.graph.search


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.

Update the properties of a bookmark object.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet


Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) SearchConfiguration.Read.All SearchConfiguration.ReadWrite.All
Delegated (personal Microsoft account) Not supported. Not supported.
Application SearchConfiguration.Read.All SearchConfiguration.ReadWrite.All

HTTP request

PATCH /search/bookmarks/{bookmarksId}

Request headers

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

Request body

In the request body, supply only the values for properties that should be updated. Existing properties that aren't included in the request body maintains their previous values or be recalculated based on changes to other property values.

The following table specifies the properties that can be updated.

Note: Updates to collection properties will update the entire collection. Any updates to a collection, such as keywords or categories, will replace the collection entirely.

Property Type Description
availabilityEndDateTime DateTimeOffset Timestamp of when the bookmark will stop to appear as a search result. Set as null for always available.
availabilityStartDateTime DateTimeOffset Timestamp of when the bookmark will start to appear as a search result. Set as null for always available.
categories String collection Categories commonly used to describe this bookmark. For example, IT and HR.
description String Bookmark description shown on search results page. Inherited from searchAnswer.
displayName String Bookmark name displayed in search results. Inherited from searchAnswer.
groupIds String collection List of security groups able to view this bookmark.
keywords microsoft.graph.search.answerKeyword Keywords that trigger this bookmark to appear in search results.
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.
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.
state microsoft.graph.search.answerState State of the bookmark. Possible values are: published, draft, excluded, or unknownFutureValue.
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.
webUrl String Bookmark URL link. When users click this bookmark in search results, they will go to this URL. Inherited from searchAnswer.


If successful, this method returns a 204 No Content response code.



The following is an example of a request.

PATCH https://graph.microsoft.com/beta/search/bookmarks/{bookmarksId}
Content-Type: application/json

  "description": "Book a fancy vacation in Tuscany or browse museums in Florence."


The following example shows the response.

HTTP/1.1 204 No Content