Delete a Bookmark

Tier	Tier Name	Named Users	Description
Tier 1	Starter	Up to 10	Designed for small-scale implementations or pilot environments
Tier 2	Growth	Up to 1000	Suitable for mid-scale deployments requiring moderate scalability
Tier 3	Enterprise	Greater than 1000	Supports large-scale environments with extended configuration options

Resource	Limits	Starter	Growth	Enterprise
Article Reference	Number of attachments used in any article	25	50	50
	Number of custom attributes in an article	10	25	50
	Number of publish views used in an article version	20	20	20
Topic Reference	User-defined topics in a department	1000	5000	50000
	Depth of topics	5	20	20
	Topics at any level	500	2500	2500
	Number of custom attributes in a topic	10	10	10
Portal Reference	Tag categories in a portal	15	15	15
	Topics to be included in a portal	100	500	5000
	Number of articles to display in announcements	10	25	25
	Usage links and link groups setup for a portal	5	10	25

Article

Article APIs

Operations

Article Lists

Article List APIs

Operations

Bookmark

Bookmark APIs

Operations

Add a Bookmark

Request

Overview

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

Security

oAuthUser(Required scopes: ) or oAuthOnBehalfOfUser(Required scopes: ) or oAuthCustomer(Required scopes: ) or oAuthOnBehalfOfCustomer(Required scopes: )

Path

portalIDstring[ 7 .. 20 ] characters^[a-zA-Z0-9]{2,4}-\d{4,15}$required

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.

Example: PROD-1000

Headers

x-egain-activity-idstring[ 4 .. 9 ] characters^[0-9]{4,9}$

A unique numeric interaction identifier from eGain.

Example: 59237

x-ext-integration-idstring<= 40 characters^[\w\W]+$

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.

Examples:

uuid 3155180e-0c13-43e9-9c38-e9045bcbf176

hex 00Dbn00000IxGnx

x-ext-interaction-idstring<= 40 characters^[\w\W]+$

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.

Examples:

uuid 3155180e-0c13-43e9-9c38-e9045bcbf176

hex 00Dbn00000IxGnx

Content-Typestringrequired

The media type sent by the client.

Default application/json

Value"application/json"

Accept-Languagestringrequired

The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).

Enum"en-US""es-ES""fr-FR""it-IT""de-DE""nl-NL""pt-BR""pt-PT""da-DK""ru-RU"

Example: en-US

Bodyapplication/jsonrequired

resourceIdstring[ 7 .. 20 ]^[a-zA-Z0-9]{2,4}-\d{4,15}$

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

Example: "DEV-7692"

userIdstring[ 1 .. 10 ] characters^[1-9]\d*$

The ID of the user associated with the bookmark.

Example: "1000001035"

userTypestring

The type of the user associated with the bookmark.

Enum"customer""agent"

bookmarkNamestring[ 1 .. 255 ] characters^[\w\W]+$

The name of the bookmark.

resourceTypeinteger(int32)[ 1 .. 3 ]

Determines the type of resource:

1 - Article

2 - Topic

3 - External Content

resourceNamestring[ 1 .. 255 ] characters^[\w\W]+$

The name of the resource associated with the bookmark.

This attribute is only available for article and topic bookmarks.

externalContentIdstring[ 1 .. 255 ] characters^[\w\W]+$

The ID of the external content.

This attribute must be provided if resourceType is set to "3 - External Content".

curl -i -X POST \
  https://api.egain.cloud/knowledge/portalmgr/v4/portals/PROD-1000/bookmarks \
  -H 'Accept-Language: en-US' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'x-egain-activity-id: 59237' \
  -H 'x-ext-integration-id: string' \
  -H 'x-ext-interaction-id: string' \
  -d '{
    "resourceId": "PROD-9274782",
    "resourceType": 2,
    "bookmarkName": "DemoBookmark"
  }'

Responses

Created

Response

No content

Get All Bookmarks for a Portal

Request

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.

Security

oAuthUser(Required scopes: ) or oAuthOnBehalfOfUser(Required scopes: ) or oAuthCustomer(Required scopes: ) or oAuthOnBehalfOfCustomer(Required scopes: )

Path

portalIDstring[ 7 .. 20 ] characters^[a-zA-Z0-9]{2,4}-\d{4,15}$required

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.

Example: PROD-1000

Headers

x-egain-activity-idstring[ 4 .. 9 ] characters^[0-9]{4,9}$

A unique numeric interaction identifier from eGain.

Example: 59237

x-ext-integration-idstring<= 40 characters^[\w\W]+$

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.

Examples:

uuid 3155180e-0c13-43e9-9c38-e9045bcbf176

hex 00Dbn00000IxGnx

x-ext-interaction-idstring<= 40 characters^[\w\W]+$

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.

Examples:

uuid 3155180e-0c13-43e9-9c38-e9045bcbf176

hex 00Dbn00000IxGnx

Accept-Languagestringrequired

The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).

Enum"en-US""es-ES""fr-FR""it-IT""de-DE""nl-NL""pt-BR""pt-PT""da-DK""ru-RU"

Example: en-US

curl -i -X GET \
  https://api.egain.cloud/knowledge/portalmgr/v4/portals/PROD-1000/bookmarks \
  -H 'Accept-Language: en-US' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-egain-activity-id: 59237' \
  -H 'x-ext-integration-id: string' \
  -H 'x-ext-interaction-id: string'

Responses

Success

Bodyapplication/json

bookmarksArray of objects(Bookmark)

paginationInfoobject(PaginationInfo)

Response

application/json

{
  "bookmark": [
    { … }
  ],
  "paginationInfo": {
    "count": 1,
    "pagenum": 1,
    "pagesize": 10
  }
}