Get Suggestion by ID

Overview

The Get Suggestion by ID API allows authenticated users to retrieve their own suggestions.

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 for the ID" 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
query Parameters
suggestionAdditionalAttributes
Array of strings

The attributes of a Suggestion 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' returns all attributes.

Default Attributes

These Suggestion attributes are always returned:

Name Description
id The ID of the Suggestion.
name The name of the Suggestion.
status The status of the Suggestion.
description The description of the Suggestion.
language Details about the language of the Suggestion.
modifiedBy.id The ID of the user that last modified the Suggestion.
modifiedBy.firstName The Suggestion's last modified user's first name.
modifiedBy.middleName The Suggestion's last modified user's middle name.
modifiedBy.lastName The Suggestion's last modified user's last name.
modifiedDate The Suggestion's last modified date and information about the user that last modified the Suggestion.
link The link object, used to retrieve the details of the Suggestion.
hasComments The Suggestion has one or more comments
hasAttachments The Suggestion has one or more attachments
hasRelatedArticles The Suggestion has related articles
Items Enum: "content" "modifiedBy.userName" "all" Examples:
An additional attribute to be returned.
suggestionAdditionalAttributes=content
Additional attributes to be returned.
suggestionAdditionalAttributes=content,modifiedBy.userName
All additional attributes to be returned.
suggestionAdditionalAttributes=all
$customAdditionalAttributes
string [ 1 .. 4000 ] characters ^([a-zA-Z0-9_-]+)(?:,[a-zA-Z0-9_-]+)*$

One or more comma-separated names for custom attributes defined by the user to be returned.

Examples:
A user-defined custom attribute.
$customAdditionalAttributes=country_name
Multiple user-defined custom attributes.
$customAdditionalAttributes=internalScore,performance-rating_dept_923
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}
Request samples
Response samples
application/json
{
  • "link": {
    },
  • "name": "Missing Article Information",
  • "description": "Missing Account Type Information",
  • "content": "<p>There should be an article that explains the account types offered. That would be very helpful.<br /></p>",
  • "status": {
    },
  • "modifiedBy": {
    },
  • "modifiedDate": "2025-01-23T04:16:17.000Z",
  • "language": {
    },
  • "hasRelatedArticles": false,
  • "hasAttachments": false,
  • "hasComments": true,
  • "customAttribute": [ ],
  • "id": "PROD-3259"
}