Add a Bookmark
Overview
- The Add a Bookmark API adds a bookmark from a portal.
Authorization
accessToken JWT Bearer Token authentication for API access
In: header
Path Parameters
The ID of the portal being accessed.A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.
^[a-zA-Z0-9]{2,4}-\d{4,15}$7 <= length <= 20Header Parameters
A unique numeric interaction identifier from eGain.
^[0-9]{4,9}$4 <= length <= 9The unique numeric identifier for a tenant, used in self-service functionality as well as third-party integrations.Note: The x-ext-integration-id and x-ext-interaction-id headers must always be provided together and cannot be supplied independently.The x-egain-activity-id may be provided on its own, or it may be provided along with both x-ext-integration-id and x-ext-interaction-id.
^[\w\W]+$length <= 40A unique interaction identifier from other CRM applications.Note: The x-ext-integration-id and x-ext-interaction-id headers must always be provided together and cannot be supplied independently.The x-egain-activity-id may be provided on its own, or it may be provided along with both x-ext-integration-id and x-ext-interaction-id.
^[\w\W]+$length <= 40The media type sent by the client.
"application/json"Value in
- "application/json"
The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
Value in
- "en-US"
- "es-ES"
- "fr-FR"
- "it-IT"
- "de-DE"
- "nl-NL"
- "pt-BR"
- "pt-PT"
- "da-DK"
- "ru-RU"
- "fr-CA"
- "zh-CN"
- "ja-JP"
- "ko-KR"
- "sv-SE"
Request Body
application/json
The ID of the article or topic associated with this bookmark. A case ID or an article ID is composed of a 2-4 letter prefix, followed by a dash and 15 digits.This attribute must be provided if resourceType is set to "1 - Article" or "2 - Topic".
^[a-zA-Z0-9]{2,4}-\d{4,15}$7 <= value <= 20The ID of the user associated with the bookmark.
^[1-9]\d*$1 <= length <= 10The type of the user associated with the bookmark.
Value in
- "customer"
- "agent"
The name of the bookmark.
^[\w\W]+$1 <= length <= 255Determines the type of resource:
int321 <= value <= 3The name of the resource associated with the bookmark.This attribute is only available for article and topic bookmarks.
^[\w\W]+$1 <= length <= 255The ID of the external content.This attribute must be provided if resourceType is set to "3 - External Content".
^[\w\W]+$1 <= length <= 255Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/knowledge/portalmgr/v4/portals/PROD-1000/bookmarks" \ -H "x-egain-activity-id: 59237" \ -H "x-ext-integration-id: 3155180e-0c13-43e9-9c38-e9045bcbf176" \ -H "x-ext-interaction-id: 3155180e-0c13-43e9-9c38-e9045bcbf176" \ -H "Content-Type: application/json" \ -H "Accept-Language: en-US" \ -H "Content-Type: application/json" \ -d '{ "resourceId": "PROD-9274782", "resourceType": 2, "bookmarkName": "DemoBookmark" }'Get All Bookmarks for a Portal GET
## Overview The Get All Bookmarks for a Portal API returns all bookmarks for a portal. Only the topic bookmarks that are available in the scope of the portal are returned. ## Permissions * The user must have the __View Author Portal__ action to access the authoring view. * The user must have the __View Staging Portal__ action to access the staging view.
Delete a Bookmark DELETE
## Overview The Delete a Bookmark API deletes a bookmark from a portal.

