Add a bookmark

Overview

Add a bookmark from a portal

SecurityoAuthUser or oAuthCustomer
Request
path Parameters
portalID
required
number
Example: 202200000001001
header Parameters
Content-Type
required
string
Default: application/json

Media type sent by the client.

Enum: "application/json" "application/xml" "application/x-www-form-urlencoded" "multipart/form-data" "text/plain"
Accept-Language
required
string
Default: en-US

Language locale accepted by 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"
X-egain-tenant-id
string

Unique identifier for tenant.

X-egain-activity-id
integer

Numeric unique identifier of interaction from eGain.

X-interaction-id
string

Unique identifier for interaction from other CRM applications.

Request Body schema: application/x-www-form-urlencoded
id
number

ID of the bookmark

resourceId
required
number

ID of the object associated with this bookmark.

resourceType
number

Determines the type of resource:

  • 1 - article
  • 2 - topic
  • 3 - external content
    • userId
    number

    ID of the user associated with bookmark.

    userType
    number

    Type of the user associated with bookmark.

    portalId
    number

    ID of the portal associated with bookmark.

    readableResourceId
    string

    Readable ID of the resource associated with bookmark. This attribute is available only for article and topic type bookmarks.

    resourceName
    string

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

    object (XsDateTime)
    bookmarkName
    string

    User provided bookmark name.

    externalContentId
    string

    The id of the external content.

    Responses
    201

    Created

    400

    Bad Request

    401

    Unauthorized

    403

    Forbidden

    404

    Not Found

    406

    Not acceptable

    500

    Internal server error

    post/portals/{portalID}/bookmarks
    Request samples
    application/x-www-form-urlencoded
    resourceId=202200000001037&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>"
    }