# Make a Suggestion ## 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. Endpoint: POST /portals/{portalID}/suggestions Security: oAuthUser, oAuthOnBehalfOfUser, oAuthCustomer, oAuthOnBehalfOfCustomer, oAuthAnonymousCustomer ## Path parameters: - `portalID` (string, 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. ## Header parameters: - `x-egain-activity-id` (string) A unique numeric interaction identifier from eGain. - `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.* - `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.* - `Content-Type` (string, required) The media type sent by the client. - `Accept-Language` (string, required) The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses). ## Request fields (application/json): - `name` (string, required) The name of the Suggestion. - `description` (string) The description of the Suggestion. - `content` (string, required) The content of the Suggestion. - `feedbackArticle` (object) The Article that the Suggestion was created for. - `feedbackArticle.id` (string) The ID of a Related Article.An Article ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits. Example: PROD-9821 - `attachments` (object) Details of Attachments for the Suggestion. - `attachments.attachment` (array) The list of Attachments. - `attachments.attachment.altId` (string) The alternate Id of the Attachment that was obtained after calling **[Generate signed URL to upload an attachment](../../../../../apis/v3/core/filemgr/api-bundled/storageservice/generatepreuploadurl)**. - `language` (object, required) The knowledge base language in which the Suggestion is created. - `language.code` (string, required) The code of the language. Enum: "en-US", "fr-FR", "en-GB", "es-ES", "it-IT", "nl-NL", "da-DA", "sv-SE", "pt-PT", "fi-FI", "no-NB", "no-NN", "ja-JA", "de-DE", "pt-BR", "zh-CN", "zh-TW", "ko-KO", "ru-RU", "el-EL", "tr-TR", "pl-PL", "cs-CS", "sk-SK", "hu-HU", "sr-SR", "ar-SA", "hr-HR", "ro-RO", "th-TH", "de-AT", "vi-VN", "id-ID", "ms-MY", "fil-PH", "fr-CA", "hi-IN", "uk-UA", "bg-BG", "sl-SI", "da-DK", "nb-NO", "nn-NO", "ja-JP", "ko-KR", "el-GR", "cs-CZ", "sr-RS", "zh-Hans", "zh-Hant", "ar-AE", "xx-XX" - `customAttributes` (array) The Custom Attributes of the Suggestion. - `customAttributes.name` (string) The custom attribute's name. - `customAttributes.value` (array) The custom attribute's values. - `customAttributes.type` (string) The custom attribute's type. Enum: "STRING", "INTEGER", "BOOLEAN", "DATETIME" ## Response 400 fields (application/json): - `code` (string, required) A string that follows the pattern *{integer}-{integer}*. The first *{integer}* is the http status code. This code as a whole is unique. * For example, error codes "400-101" and "404-101" are distinctly different. - `developerMessage` (string, required) A summary of the error. - `details` (array) - `details.key` (string, required) - `details.value` (string) - `userMessage` (string) UI friendly messages are only supported by some APIs. * The client must explicitly request UI friendly messages by passing the *X-egain-error-message=yes* header. ## Response 401 fields (application/json): - `code` (string, required) A string that follows the pattern *{integer}-{integer}*. The first *{integer}* is the http status code. This code as a whole is unique. * For example, error codes "400-101" and "404-101" are distinctly different. - `developerMessage` (string, required) A summary of the error. - `details` (array) - `details.key` (string, required) - `details.value` (string) - `userMessage` (string) UI friendly messages are only supported by some APIs. * The client must explicitly request UI friendly messages by passing the *X-egain-error-message=yes* header. ## Response 403 fields (application/json): - `code` (string, required) A string that follows the pattern *{integer}-{integer}*. The first *{integer}* is the http status code. This code as a whole is unique. * For example, error codes "400-101" and "404-101" are distinctly different. - `developerMessage` (string, required) A summary of the error. - `details` (array) - `details.key` (string, required) - `details.value` (string) - `userMessage` (string) UI friendly messages are only supported by some APIs. * The client must explicitly request UI friendly messages by passing the *X-egain-error-message=yes* header. ## Response 404 fields (application/json): - `code` (string, required) A string that follows the pattern *{integer}-{integer}*. The first *{integer}* is the http status code. This code as a whole is unique. * For example, error codes "400-101" and "404-101" are distinctly different. - `developerMessage` (string, required) A summary of the error. - `details` (array) - `details.key` (string, required) - `details.value` (string) - `userMessage` (string) UI friendly messages are only supported by some APIs. * The client must explicitly request UI friendly messages by passing the *X-egain-error-message=yes* header. ## Response 406 fields (application/json): - `code` (string, required) A string that follows the pattern *{integer}-{integer}*. The first *{integer}* is the http status code. This code as a whole is unique. * For example, error codes "400-101" and "404-101" are distinctly different. - `developerMessage` (string, required) A summary of the error. - `details` (array) - `details.key` (string, required) - `details.value` (string) - `userMessage` (string) UI friendly messages are only supported by some APIs. * The client must explicitly request UI friendly messages by passing the *X-egain-error-message=yes* header. ## Response 500 fields (application/json): - `code` (string, required) A string that follows the pattern *{integer}-{integer}*. The first *{integer}* is the http status code. This code as a whole is unique. * For example, error codes "400-101" and "404-101" are distinctly different. - `developerMessage` (string, required) A summary of the error. - `details` (array) - `details.key` (string, required) - `details.value` (string) - `userMessage` (string) UI friendly messages are only supported by some APIs. * The client must explicitly request UI friendly messages by passing the *X-egain-error-message=yes* header.