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.
SecurityoAuthUser or oAuthOnBehalfOfUser or oAuthCustomer or oAuthOnBehalfOfCustomer
Request
path Parameters
portalID
required
string [ 7 .. 20 ] characters ^[a-zA-Z0-9]{2,4}-\d{4,15}$

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.

Example: PROD-1000
suggestionID
required
string [ 7 .. 20 ] characters ^[a-zA-Z0-9]{2,4}-\d{4,15}$

The ID of the Suggestion.

A Suggestion ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.

Example: PROD-11829
header Parameters
x-egain-activity-id
string [ 4 .. 9 ] characters ^[0-9]{4,9}$

A unique numeric interaction identifier from eGain.

Example: 59237
x-ext-integration-id
string <= 40 characters ^[\w\W]+$

The unique numeric identifier for a tenant, used in self-service functionality as well as third-party integrations.

Note: If x-egain-activity-id is not provided, then this must be passed along with x-ext-interaction-id.

Examples:
3155180e-0c13-43e9-9c38-e9045bcbf176
00Dbn00000IxGnx
x-ext-interaction-id
string <= 40 characters ^[\w\W]+$

A unique interaction identifier from other CRM applications.

Note: If x-egain-activity-id is not provided, then this must be passed along with x-ext-integration-id.

Examples:
3155180e-0c13-43e9-9c38-e9045bcbf176
00Dbn00000IxGnx
Accept-Language
required
string

The Language locale accepted by the 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"
Example: en-US
Responses
200

Success

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Not acceptable

500

Internal server error

get/portals/{portalID}/suggestions/{suggestionID}/comments
Request samples
Response samples
application/json
{
  • "count": 1,
  • "comments": [
    ]
}