Get Suggestion by Id

Overview

This API allows eGain users and authenticated customers to retrieve their own suggestion by its ID.

For this API to execute successfully:

  • The suggestion with id or alternateId specified in the URL must belong to the user.
  • The setting "Manage Suggestion" must be enabled for the portal specified in the URL.
  • If the user is a customer, the setting “Allow customer access” must be enabled for the portal.
SecurityoAuthUser or oAuthCustomer
Request
path Parameters
portalID
required
number
Example: 202200000001001
id
required
string <= 255 characters

id of object

Example: 1001
query Parameters
$attribute
string

Server can be prompted to return additional attributes of resource representation using $attribute common query parameter.
Available Values id,name,status,description,content,lastModified,attachments,comments,language,all, custom.<name>
Examples:
Attribute 'name' is returned in server response.
$attribute=name
All the attributes are returned in server response.
$attribute=all
header Parameters
Accept-Language
required
string
Default: en-US

Language locale accepted by 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"
X-egain-tenant-id
string

Unique identifier for tenant.

X-egain-activity-id
integer

Numeric unique identifier of interaction from eGain.

X-interaction-id
string

Unique identifier for interaction from other CRM applications.

Responses
200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Not acceptable

500

Internal server error

get/portals/{portalID}/suggestions/{id}
Request samples
Response samples
application/json
{
  • "suggestion": [
    ]
}