Add a Bookmark

Overview

  • The Add a Bookmark API adds a bookmark from a portal.
SecurityoAuthUser or oAuthOnBehalfOfUser or oAuthCustomer or oAuthOnBehalfOfCustomer
Request
path Parameters
portalID
required
string [ 7 .. 20 ] characters ^[a-zA-Z0-9]{2,4}-\d{4,15}$

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
header Parameters
x-egain-activity-id
string [ 4 .. 9 ] characters ^[0-9]{4,9}$

A unique numeric interaction identifier from eGain.

Example: 59237
x-ext-integration-id
string <= 40 characters ^[\w\W]+$

The unique numeric identifier for a tenant, used in self-service functionality as well as third-party integrations.

Note: If x-egain-activity-id is not provided, then this must be passed along with x-ext-interaction-id.

Examples:
3155180e-0c13-43e9-9c38-e9045bcbf176
00Dbn00000IxGnx
x-ext-interaction-id
string <= 40 characters ^[\w\W]+$

A unique interaction identifier from other CRM applications.

Note: If x-egain-activity-id is not provided, then this must be passed along with x-ext-integration-id.

Examples:
3155180e-0c13-43e9-9c38-e9045bcbf176
00Dbn00000IxGnx
Content-Type
required
string
Default: application/json

The media type sent by the client.

Value: "application/json"
Accept-Language
required
string

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" "fr-CA" "zh-CN" "ja-JP" "ko-KR" "sv-SE"
Example: en-US
Request Body schema: application/json
resourceId
string [ 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".

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

The ID of the user associated with the bookmark.

userType
string

The type of the user associated with the bookmark.

Enum: "customer" "agent"
bookmarkName
string [ 1 .. 255 ] characters ^[\w\W]+$

The name of the bookmark.

resourceType
integer <int32> [ 1 .. 3 ]

Determines the type of resource:

  • 1 - Article
  • 2 - Topic
  • 3 - External Content
    • resourceName
    string [ 1 .. 255 ] characters ^[\w\W]+$

    The name of the resource associated with the bookmark.

    This attribute is only available for article and topic bookmarks.

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

    The ID of the external content.

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

    Responses
    201

    Created

    400

    Bad Request

    401

    Unauthorized

    403

    Forbidden

    404

    Not Found

    406

    Not acceptable

    415

    Incorrect Content Type Header

    500

    Internal server error

    post/portals/{portalID}/bookmarks
    Request samples
    application/json
    {
    • "resourceId": "PROD-9274782",
    • "resourceType": 2,
    • "bookmarkName": "DemoBookmark"
    }
    Response samples
    application/json

    Required query parameter is missing.

    {
    • "code": "400-112",
    • "developerMessage": "Required query parameter(s) is missing. The following parameters are required: <param name>"
    }