Make a Suggestion
Overview
The Make a Suggestion API allows users to create an Article Suggestion from within a knowledge portal.
Prerequisites
- Enable the setting "Manage a Suggestion" for the portal specified in the URL.
- If the user is a Customer, enable the setting "Allow Customer Access" for the portal.
- If you want to add an attachment to a Suggestion, first call the Generate Signed URL to Upload API to add an attachment using the provided returned altID in attachment request.
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 <= 20Header Parameters
A unique numeric interaction identifier from eGain.
^[0-9]{4,9}$4 <= length <= 9The 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 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 <= 40The media type sent by the client.
"application/json"Value in
- "application/json"
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"
Request Body
application/json
This schema contains information about a Suggestion.
The name of the Suggestion.
^[\s\S]*\S[\s\S]*$1 <= length <= 255The description of the Suggestion.
^[\w\W]*$length <= 255The content of the Suggestion.
^[\s\S]*\S[\s\S]*$1 <= length <= 4000The Article that the Suggestion was created for.
Details of Attachments for the Suggestion.
The knowledge base language in which the Suggestion is created.
The Custom Attributes of the Suggestion.
items <= 15Response 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/suggestions" \ -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" \ -H "Content-Type: application/json" \ -H "Accept-Language: en-US" \ -H "Content-Type: application/json" \ -d '{ "name": "Proposed Store Phone Number", "content": "You should update your website with the new phone number.", "language": { "code": "en-US" } }'Get Suggestion by Status GET
## Overview The Get Suggestion by Status API allows authenticated users to retrieve their own suggestions based on Suggestion status. ## Prerequisites * Enable the setting "My Suggestions" for the portal specified in the URL. * If the user is a customer, enable the setting "Allow Customer Access" for the portal.
Modify Suggestion PUT
## Overview The Modify Suggestion API allows authenticated users to modify their own Suggestion. ## Prerequisites * Enable the setting "Manage a Suggestion" for the portal specified in the URL. * If the user is a Customer, enable the setting "Allow Customer Access" for the portal. * The "Suggestion ID" specified in the request body must exist and belong to the user. * The status of this Suggestion as returned by the Get Suggestion by ID API must be "pending". * At least one of the optional request body attributes must be provided.

