Skip to content
Knowledge APIs
/
Portal Manager
/
/Bookmark

Add a Bookmark

Request

Overview

  • The Add a Bookmark API adds a bookmark from a portal.
Security
oAuthUser(Required scopes:
https://api.egain.cloud/auth/kno...
) or oAuthOnBehalfOfUser(Required scopes:
https://api.egain.cloud/auth/kno...
) or oAuthCustomer(Required scopes:
https://api.egain.cloud/auth/kno...
) or oAuthOnBehalfOfCustomer(Required scopes:
https://api.egain.cloud/auth/kno...
)
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".

    POST
    /portals/{portalID}/bookmarks
    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: 3155180e-0c13-43e9-9c38-e9045bcbf176' \
  -H 'x-ext-interaction-id: 3155180e-0c13-43e9-9c38-e9045bcbf176' \
  -d '{
    "resourceId": "PROD-9274782",
    "resourceType": 2,
    "bookmarkName": "DemoBookmark"
  }'

    Responses

    Created

    Response
    No content