Get Related Articles for Suggestion
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.
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 <= 20Query Parameters
The attributes of an Article to be returned in addition to the default list of attributes, listed below. Multiple additional attributes can be specified using a comma-separated list. Passing 'all' will return all attributes.
Default Attributes
These Article attributes are always returned:
| Name | Description |
|---|---|
| id | The ID of the Article. |
| name | The name of the Article. |
| articleType | The Article Type and its attributes. |
| createdBy | The ID, first name, middle name and last name of the user that created the Article. |
| createdDate | The date that the Article was created. |
| hasAttachments | True: The Article has one or more attachments.False: The Article does not have any attachments. |
| languageCode | The language code of the Article language. |
| modifiedBy | The ID, first name, middle name and last name of the user that last modified the Article. |
| modifiedDate | The date that the Article was last modified on. |
| link | The link object, used to retrieve the details of the Article. |
| versionId | The ID of the Article version that is returned. |
Header 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/relatedArticles?articleResultAdditionalAttributes=averageRating" \ -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"{ "name": "Feedback", "id": "PROD-3259", "relatedArticles": [ { "id": "PROD-3002", "name": "Fair Lending", "createdBy": { "id": "1013", "firstName": "John", "middleName": "", "lastName": "Doe" }, "createdDate": "2022-06-30T18:25:22Z", "hasAttachments": false, "languageCode": "en-US", "modifiedBy": { "id": "1013", "firstName": "John", "middleName": "", "lastName": "Doe" }, "modifiedDate": "2025-01-28T20:58:11Z", "link": { "rel": "self", "href": "/knowledge/portalmgr/v4/portals/PROD-1000/articles/PROD-3002?%&workflowMilestone=publish&filter%5Btags%5D=PROD-5381&%24lang=en-US" }, "versionId": "PROD-2897" } ]}Delete a Suggestion DELETE
## Overview The Delete a Suggestion API allows authenticated users to delete 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 must belong to the user. * The status of the Suggestion must not be "approved".
Get Suggestion Comments GET
## 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.

