Create Quickpick

Overview

This API can be used to create a new quickpick(bookmark) for current guided help search session.

PreCondition

  • A Guided help search session must be in progress before this API is invoked.
  • QuickPick can only be created for a live release of a casebase.

Request Body

Request body is required for this operation. If linkToActivity attribute is passed as true in request body then one of below must be passed in header

  • XEgainTenantId
  • XEgainActivityId
  • XInteractionId
SecurityoAuthUser or oAuthCustomer
Request
path Parameters
portalID
required
number
Example: 202200000001001
query Parameters
$lang
string

The knowledge base language used for retrieving response. Must be a language accessible to user. If this parameter is not passed, default language of the system is used.

Enum: "en-US" "en-GB" "fr-FR" "es-ES" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DK" "sv-SE" "ru-RU" "fr-CA" "zh-CN" "ja-JP" "ko-KR"
Example: $lang=en-US
header Parameters
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 quick pick

name
string

name of the quick pick

comment
string

comment about quick pick

casebaseId
number

casebase for which quickpick is to be created

linkToActivity
string

indicates if quickpick is to be linked with activity

Value: "yes"
object (Link)
Responses
201

Quickpick Created Successfully.

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Not acceptable

500

Internal server error

post/portals/{portalID}/gh/quickpicks
Request samples
application/x-www-form-urlencoded
casebaseId=202201000000008&name=QuickPick82700245&comment=demo%20quickpick
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>"
}