Delete Suggestion

Overview

This API allows eGain users and authenticated customers to delete their own suggestion identified 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 status of this suggestion as returned by "Get Suggestion by ID" API must not be approved.
  • 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
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
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Not acceptable

500

Internal server error

delete/portals/{portalID}/suggestions/{id}
Request samples
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>"
}