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.
This API is available in the following national cloud deployments.
Global service | US Government L4 | US Government L5 (DOD) | China operated by 21Vianet |
---|---|---|---|
✅ | ❌ | ❌ | ❌ |
Permissions
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
POST /search/bookmarks
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
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 |
---|---|---|
availabilityEndDateTime | DateTimeOffset | Date and time when the bookmark stops appearing as a search result. Set as null for always available. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z . |
availabilityStartDateTime | DateTimeOffset | Date and time when the bookmark starts to appear as a search result. Set as null for always available. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z . |
categories | String collection | Categories commonly used to describe this bookmark. For example, IT and HR . |
description | String | The bookmark description that is shown on the search results page. Inherited from searchAnswer. |
displayName | String | The bookmark name that is displayed in search results. Inherited from searchAnswer. |
groupIds | String collection | The list of security groups that are able to view this bookmark. |
keywords | microsoft.graph.search.answerKeyword | Keywords that trigger this bookmark to appear in search results. |
languageTags | String collection | A list of geographically specific language names in which this bookmark can be viewed. Each language tag value follows the pattern {language}-{region}. For example, en-us is English as used in the United States. For the list of possible values, see Supported language tags. |
platforms | microsoft.graph.devicePlatformType collection | List of devices and operating systems that are able to view this bookmark. Possible values are: android , androidForWork , ios , macOS , windowsPhone81 , windowsPhone81AndLater , windows10AndLater , androidWorkProfile , unknown , androidASOP , androidMobileApplicationManagement , iOSMobileApplicationManagement , unknownFutureValue . |
powerAppIds | String collection | List of Power Apps associated with this bookmark. If users add existing Power Apps to a bookmark, they can complete tasks directly on the search results page, such as entering vacation time or reporting expenses. |
state | microsoft.graph.search.answerState | State of the bookmark. Possible values are: published , draft , excluded , 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 apply to all variations. |
webUrl | String | The URL link for the bookmark. When users select this bookmark from the search results, they're directed to the specified URL. Inherited from searchAnswer. |
Response
If successful, this method returns a 201 Created
response code with the ID of the bookmark created.
Examples
Request
The following example shows a 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": ["Unique keyword"],
"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
The following example shows the response.
HTTP/1.1 201 Created
Location: /733b26d5-af76-4eea-ac69-1a0ce8716897
Content-Type: application/json
{
"id": "733b26d5-af76-4eea-ac69-1a0ce8716897"
}
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for