Bookmark

Add a Bookmark

POST
/knowledge/portalmgr/v4/portals/{portalID}/bookmarks

Overview

  • The Add a Bookmark API adds a bookmark from a portal.

Authorization

accessToken
AuthorizationBearer <token>

JWT Bearer Token authentication for API access

In: header

Path Parameters

portalID*string

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.

Match^[a-zA-Z0-9]{2,4}-\d{4,15}$
Length7 <= length <= 20

Header Parameters

x-egain-activity-id?string

A unique numeric interaction identifier from eGain.

Match^[0-9]{4,9}$
Length4 <= length <= 9
x-ext-integration-id?string

The 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.

Match^[\w\W]+$
Lengthlength <= 40
x-ext-interaction-id?string

A 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.

Match^[\w\W]+$
Lengthlength <= 40
Content-Type*"application/json"

The media type sent by the client.

Default"application/json"

Value in

  • "application/json"
Accept-Language*string

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

resourceId?string

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".

Match^[a-zA-Z0-9]{2,4}-\d{4,15}$
Range7 <= value <= 20
userId?string

The ID of the user associated with the bookmark.

Match^[1-9]\d*$
Length1 <= length <= 10
userType?string

The type of the user associated with the bookmark.

Value in

  • "customer"
  • "agent"
bookmarkName?string

The name of the bookmark.

Match^[\w\W]+$
Length1 <= length <= 255
resourceType?integer

Determines the type of resource:

Formatint32
Range1 <= value <= 3
resourceName?string

The name of the resource associated with the bookmark.This attribute is only available for article and topic bookmarks.

Match^[\w\W]+$
Length1 <= length <= 255
externalContentId?string

The ID of the external content.This attribute must be provided if resourceType is set to "3 - External Content".

Match^[\w\W]+$
Length1 <= length <= 255

Response 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"  }'
Empty