Suggestion

Make a Suggestion

Request

Overview

The Make a Suggestion API allows users to create an Article Suggestion from within a knowledge portal.

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.
If you want to add an attachment to a Suggestion, first call the Generate Signed URL to Upload API to add an attachment using the provided returned altID in attachment request.

Security

oAuthUser(Required scopes: ) or oAuthOnBehalfOfUser(Required scopes: ) or oAuthCustomer(Required scopes: ) or oAuthOnBehalfOfCustomer(Required scopes: ) or oAuthAnonymousCustomer(Required scopes: )

Path

portalIDstring, [ 7 .. 20 ] characters^[a-zA-Z0-9]{2,4}-\d{4,15}$required

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

x-egain-activity-idstring, [ 4 .. 9 ] characters^[0-9]{4,9}$

A unique numeric interaction identifier from eGain.

Example:59237

x-ext-integration-idstring, <= 40 characters^[\w\W]+$

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

Note: The x-ext-integration-id and x-ext-interaction-id headers must always be provided together and cannot be supplied independently.

The x-egain-activity-id may be provided on its own, or it may be provided along with both x-ext-integration-id and x-ext-interaction-id.

Examples:

uuid

3155180e-0c13-43e9-9c38-e9045bcbf176

hex

00Dbn00000IxGnx

x-ext-interaction-idstring, <= 40 characters^[\w\W]+$

A unique interaction identifier from other CRM applications.

Note: The x-ext-integration-id and x-ext-interaction-id headers must always be provided together and cannot be supplied independently.

The x-egain-activity-id may be provided on its own, or it may be provided along with both x-ext-integration-id and x-ext-interaction-id.

Examples:

uuid

3155180e-0c13-43e9-9c38-e9045bcbf176

hex

00Dbn00000IxGnx

Content-Typestringrequired

The media type sent by the client.

Default:"application/json"

Value:"application/json"

Accept-Languagestringrequired

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"

Example:en-US

Bodyapplication/json

namestring, [ 1 .. 255 ] characters^[\s\S]*\S[\s\S]*$required

The name of the Suggestion.

descriptionstring, [ 0 .. 255 ] characters^[\w\W]*$

The description of the Suggestion.

contentstring, [ 1 .. 10000 ] characters^[\s\S]*\S[\s\S]*$required

The content of the Suggestion.

feedbackArticleobject(RelatedArticleForCreateUpdateDeleteSuggestion)

The Article that the Suggestion was created for.

attachmentsobject(attachments)

Details of Attachments for the Suggestion.

languageobject(Language)required

The knowledge base language in which the Suggestion is created.

customAttributesArray of objects, [ 0 .. 15 ] items(CustomAttribute)

The Custom Attributes of the Suggestion.

POST

/portals/{portalID}/suggestions

curl -i -X POST \
  https://api.egain.cloud/knowledge/portalmgr/v4/portals/PROD-1000/suggestions \
  -H 'Accept-Language: en-US' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'x-egain-activity-id: 59237' \
  -H 'x-ext-integration-id: 3155180e-0c13-43e9-9c38-e9045bcbf176' \
  -H 'x-ext-interaction-id: 3155180e-0c13-43e9-9c38-e9045bcbf176' \
  -d '{
    "name": "Proposed Store Phone Number",
    "content": "You should update your website with the new phone number.",
    "language": {
      "code": "en-US"
    }
  }'

Responses

Created

Response

No content