Get Suggestion Comments
Overview
The Get Suggestion Comments API allows authenticated users to retrieve all comments for a Suggestion.
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.
- The Suggestion specified in the URL must belong to the user.
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 <= 20The ID of the Suggestion.A Suggestion 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 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"
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/knowledge/portalmgr/v4/portals/PROD-1000/suggestions/PROD-11829/comments" \ -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 "Accept-Language: en-US"{ "count": 1, "comments": [ { "content": "Great suggestion! We will put this on our To-Do list.", "createdBy": { "firstName": "John", "lastName": "Doe", "id": "1013" }, "createDate": "2025-01-23T04:48:25.000Z", "id": "1000" } ]}Get Related Articles for Suggestion GET
## Overview The Get Related Articles for Suggestion API allows authenticated users to retrieve related articles for a Suggestion. ## 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. * The Suggestion specified in the URL must belong to the user.
Add a Suggestion Comment POST
## Overview The Add Suggestion Comment API allows authenticated users and agents to add a new comment to a Suggestion. ## 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. * The Suggestion specified in the URL must belong to the user, or the user must have appropriate administrative permissions to comment on it. * The Suggestion must be in **Suggested** or **Pending** status, otherwise no comments can be added.

