Suggestion

Make a Suggestion

POST
/knowledge/portalmgr/v4/portals/{portalID}/suggestions

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.

Authorization

accessToken
AuthorizationBearer <token>

JWT Bearer Token authentication for API access

In: header

Path Parameters

portalID*string

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.

Match^[a-zA-Z0-9]{2,4}-\d{4,15}$
Length7 <= length <= 20

Header Parameters

x-egain-activity-id?string

A unique numeric interaction identifier from eGain.

Match^[0-9]{4,9}$
Length4 <= length <= 9
x-ext-integration-id?string

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.

Match^[\w\W]+$
Lengthlength <= 40
x-ext-interaction-id?string

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.

Match^[\w\W]+$
Lengthlength <= 40
Content-Type*"application/json"

The media type sent by the client.

Default"application/json"

Value in

  • "application/json"
Accept-Language*string

The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).

Value in

  • "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"

Request Body

application/json

This schema contains information about a Suggestion.

name*string

The name of the Suggestion.

Match^[\s\S]*\S[\s\S]*$
Length1 <= length <= 255
description?string

The description of the Suggestion.

Match^[\w\W]*$
Lengthlength <= 255
content*string

The content of the Suggestion.

Match^[\s\S]*\S[\s\S]*$
Length1 <= length <= 4000
feedbackArticle?

The Article that the Suggestion was created for.

attachments?

Details of Attachments for the Suggestion.

language*

The knowledge base language in which the Suggestion is created.

customAttributes?array<>

The Custom Attributes of the Suggestion.

Itemsitems <= 15

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/knowledge/portalmgr/v4/portals/PROD-1000/suggestions" \  -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" \  -H "Content-Type: application/json" \  -H "Accept-Language: en-US" \  -H "Content-Type: application/json" \  -d '{    "name": "Proposed Store Phone Number",    "content": "You should update your website with the new phone number.",    "language": {      "code": "en-US"    }  }'
Empty