Create Quickpick
Overview
The Create Quickpick API can be used to create a new quickpick(bookmark) for current Guided Help search session.
Note: If "linkToActivity" attribute is passed as true in request body then one of below must be passed in header
- XEgainTenantId
- xEgainActivityId
- XInteractionId
Prerequisites
- 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.
Authorization
accessToken JWT Bearer Token authentication for API access
In: header
Path Parameters
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.
^[a-zA-Z0-9]{2,4}-\d{4,15}$7 <= length <= 20Query Parameters
The language that describes the details of a resource. Resources available in different languages may differ from each other.If lang is not passed, then the portal's default language is used.
Value in
- "en-US"
- "fr-FR"
- "en-GB"
- "es-ES"
- "it-IT"
- "nl-NL"
- "da-DA"
- "sv-SE"
- "pt-PT"
- "fi-FI"
- "no-NB"
- "no-NN"
- "ja-JA"
- "de-DE"
- "pt-BR"
- "zh-CN"
- "zh-TW"
- "ko-KO"
- "ru-RU"
- "el-EL"
- "tr-TR"
- "pl-PL"
- "cs-CS"
- "sk-SK"
- "hu-HU"
- "sr-SR"
- "ar-SA"
- "hr-HR"
- "ro-RO"
- "th-TH"
- "de-AT"
- "vi-VN"
- "id-ID"
- "ms-MY"
- "fil-PH"
- "fr-CA"
- "hi-IN"
- "uk-UA"
- "bg-BG"
- "sl-SI"
- "xx-XX"
Header Parameters
The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
Value in
- "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"
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.
^[\w\W]+$length <= 40A unique numeric interaction identifier from eGain.
^[0-9]{4,9}$4 <= length <= 9A 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.
^[\w\W]+$length <= 40Request Body
application/json
name of the quick pick
^[\w\W]+$1 <= length <= 255comment about quick pick
^[\w\W]+$1 <= length <= 255The numerical ID of Live release of the Casebase.
^[1-9]\d*$15 <= length <= 15indicates if quickpick is to be linked with activity
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/knowledge/portalmgr/v4/portals/PROD-1000/gh/quickpicks" \ -H "Accept-Language: en-US" \ -H "x-ext-integration-id: 3155180e-0c13-43e9-9c38-e9045bcbf176" \ -H "x-egain-activity-id: 59237" \ -H "x-ext-interaction-id: 3155180e-0c13-43e9-9c38-e9045bcbf176" \ -H "Content-Type: application/json" \ -d '{ "casebaseReleaseId": "102312010000000", "name": "QuickPick82700245", "comment": "demo quickpick", "linkToActivity": false }'Get All Quickpicks for a Portal GET
## Overview The Get All Quickpicks for a Portal API retrieves details of quickpicks created for the Casebase. ## Conditions If "getLastSavedQuickPickForInteraction" query parameter is passed as "Yes" then one of below must be passed in request header. * X-ext-integration-id * X-egain-activity-id * X-ext-interaction-id Either casebaseID or getLastSavedQuickPickForInteraction must be passed in request.
Resume a Quickpick POST
## Overview The Resume a Quickpick API can be used to restore (resume) a specific quickpick. ## Prerequisites * A Guided Help session for the Casebase must be started before invoking this API.

