# Suggestion

Suggestion APIs

## Make a Suggestion

 - [POST /portals/{portalID}/suggestions](https://apidev.egain.com/apis/v4/knowledge/portalmgr/api-bundled/suggestion/makesuggestion.md): ## 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.

## Modify Suggestion

 - [PUT /portals/{portalID}/suggestions](https://apidev.egain.com/apis/v4/knowledge/portalmgr/api-bundled/suggestion/modifysuggestions.md): ## 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.

## Get Suggestion by Status

 - [GET /portals/{portalID}/suggestions](https://apidev.egain.com/apis/v4/knowledge/portalmgr/api-bundled/suggestion/searchsuggestion.md): ## Overview
  The Get Suggestion by Status API allows authenticated users to retrieve their own suggestions based on Suggestion status.
  
## Prerequisites
  * Enable the setting "My Suggestions" for the portal specified in the URL.
  * If the user is a customer, enable the setting "Allow Customer Access" for the portal.

## Get Suggestion by ID

 - [GET /portals/{portalID}/suggestions/{suggestionID}](https://apidev.egain.com/apis/v4/knowledge/portalmgr/api-bundled/suggestion/getsuggestion.md): ## Overview
  The Get Suggestion by ID API allows authenticated users to retrieve their own suggestions.

## Prerequisites
  * Enable the setting "My Suggestions" for the portal specified in the URL.
  * If the user is a customer, enable the setting "Allow Customer Access" for the portal.
  * The "Suggestion for the ID" specified in the URL must belong to the user.

## Delete a Suggestion

 - [DELETE /portals/{portalID}/suggestions/{suggestionID}](https://apidev.egain.com/apis/v4/knowledge/portalmgr/api-bundled/suggestion/deletesuggestion.md): ## Overview
  The Delete a Suggestion API allows authenticated users to delete 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 must belong to the user.
  * The status of the Suggestion must not be "approved".

## Get Related Articles for Suggestion

 - [GET /portals/{portalID}/suggestions/{suggestionID}/relatedArticles](https://apidev.egain.com/apis/v4/knowledge/portalmgr/api-bundled/suggestion/getrelatedarticlesforsuggestion.md): ## Overview
  The Get Related Articles for Suggestion API allows authenticated users to retrieve related articles for a Suggestion.

## Prerequisites
  * Enable the setting "My Suggestions" for the portal specified in the URL.
  * If the user is a customer, enable the setting "Allow Customer Access" for the portal.
  * The Suggestion specified in the URL must belong to the user.

## Get Suggestion Comments

 - [GET /portals/{portalID}/suggestions/{suggestionID}/comments](https://apidev.egain.com/apis/v4/knowledge/portalmgr/api-bundled/suggestion/getsuggestioncomments.md): ## Overview
  The Get Suggestion Comments API allows authenticated users to retrieve all comments for a Suggestion.

## Prerequisites
  * Enable the setting "My Suggestions" for the portal specified in the URL. 
  * If the user is a customer, enable the setting "Allow Customer Access" for the portal.
  * The Suggestion specified in the URL must belong to the user.

## Add a Suggestion Comment

 - [POST /portals/{portalID}/suggestions/{suggestionID}/comments](https://apidev.egain.com/apis/v4/knowledge/portalmgr/api-bundled/suggestion/addsuggestioncomment.md): ## Overview
  The Add Suggestion Comment API allows authenticated users and agents to add a new comment to a Suggestion.

## Prerequisites
  * Enable the setting "My Suggestions" for the portal specified in the URL.
  * If the user is a customer, enable the setting "Allow Customer Access" for the portal.
  * The Suggestion specified in the URL must belong to the user, or the user must have appropriate administrative permissions to comment on it.
  * The Suggestion must be in Suggested or Pending status, otherwise no comments can be added.

## Get Suggestion Attachments

 - [GET /portals/{portalID}/suggestions/{suggestionID}/attachments](https://apidev.egain.com/apis/v4/knowledge/portalmgr/api-bundled/suggestion/getsuggestionattachments.md): ## Overview
  The Get Suggestion Attachments API allows authenticated users to retrieve attachments for a Suggestion.

## Prerequisites
  * Enable the setting "My Suggestions" for the portal specified in the URL
  * If the user is a customer, enable the setting "Allow Customer Access" for the portal.
  * The Suggestion specified in the URL must belong to the user.

## Get Suggestion Attachment by ID

 - [GET /portals/{portalID}/suggestions/attachments/{attachmentID}](https://apidev.egain.com/apis/v4/knowledge/portalmgr/api-bundled/suggestion/getsuggestionattachmentbyid.md): ## Overview
  The Get Suggestion Attachment by ID API allows authenticated users to get the details of an attachment that belongs to their own Suggestion. It also allows the download of attachment content. 

## Prerequisites
  * Enable the setting "My Suggestions" for the portal specified in the URL
  * If the user is a customer, enable the setting "Allow Customer Access" for the portal.
  * The Suggestion specified in the URL must belong to the user.