Modify Suggestion

Overview

The Modify Suggestion API allows authenticated users to modify 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 ID" specified in the request body must exist and belong to the user.
  • The status of this Suggestion as returned by the Get Suggestion by ID API must be "pending".
  • At least one of the optional request body attributes must be provided.
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
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
Content-Type
required
string
Default: application/json

The media type sent by the client.

Value: "application/json"
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
Request Body schema: application/json
id
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.

name
string [ 1 .. 255 ] characters ^[\w\W]+$

The name of the Suggestion.

description
string [ 0 .. 255 ] characters ^[\w\W]*$

The description of the Suggestion.

content
string [ 0 .. 4000 ] characters ^[\w\W]*$

The content of the Suggestion.

modifiedDate
required
string <DateAndTime> [ 20 .. 25 ] characters ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{3})...

The date on which the Suggestion was last modified.

object (attachments)

Details of Attachments for the Suggestion.

Array of objects (CustomAttribute) [ 0 .. 15 ] items

Custom Attributes of the Suggestion.

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Not acceptable

415

Incorrect Content Type Header

500

Internal server error

put/portals/{portalID}/suggestions
Request samples
application/json
{
  • "id": "PROD-5722",
  • "name": "Improving Telecommunication Services",
  • "modifiedDate": "2024-07-31T14:10:19Z"
}
Response samples
application/json

Required query parameter is missing.

{
  • "code": "400-112",
  • "developerMessage": "Required query parameter(s) is missing. The following parameters are required: <param name>"
}