Make a Suggestion

Overview

This API allows eGain users, authenticated customers and anonymous customers to create an article suggestion in the context of a knowledge portal.

For this API to execute successfully:

The setting "Make a 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.

Request Body

For this API to work successfully following attributes must be provided in the request body

name
content

SecurityoAuthUser or oAuthCustomer or oAuthAnonymousCustomer

Request

path Parameters

portalID

required

number

Example: 202200000001001

query Parameters

$lang

required

string

The knowledge base language used for retrieving response. Must be a language accessible to user. If this parameter is not passed, default language of the system is used.

Enum: "en-US" "en-GB" "fr-FR" "es-ES" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DK" "sv-SE" "ru-RU" "fr-CA" "zh-CN" "ja-JP" "ko-KR"

Example: $lang=en-US

header Parameters

Content-Type required	string Default: application/json Media type sent by the client. Enum: "application/json" "application/xml" "application/x-www-form-urlencoded" "multipart/form-data" "text/plain"
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.

Request Body schema: application/json

id	number ID of the suggestion.
alternateId	string Readable Id of the suggestion.
	object (Link) Link to this suggestion.
name	string Name of the suggestion.
description	string Description of the suggestion.
content	string Content of the suggestion.
	object (Article) Related articles for the suggestion.
	object (L10NString) Status of the suggestion. 1 : suggested. 2 : pending 3 : declined 4 : approved
	object (DateAndUser) Last modified date of the suggestion.
	object (Attachments) Details of attachments
	object (Comments) Details of comments
	object (Language) KB language in which suggestion is created.
	object (customAttributes) Custom attributes of the activity.

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Not acceptable

500

Internal server error

post/portals/{portalID}/suggestions

Request samples

Payload
curl
JavaScript
Node.js

application/json

{"attachments": {"attachment": [{"content": "iVBORw0KGgoAAAANSUhEUgAAABgAAAA0CAYAAACQGfi1AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsQAAA7EAZUrDhsAAAOrSURBVFhH7ZdLKP1BFMeP6/3MeyMbNhJJugshr608skFISsKKsLGzwsqKBRspOwtZSZRSNh7JQiELxYLkUR55nf+c8zt3fg8Xxc9d/POp6Xfme36/mTszZ+bMBXSJ+/t7BAAu/f39oiJ6lOAKDw8PYgFcX1+LBeBaB0FBQWKpRj1ms651kJCQIBZAeHi4WAqZqh+Tlpam14DK9vY265CRkWFzuFkyMzORJo4qv4atg5SUFHh9fZXa9wgODoaLiwupGfBwOjs7ec7coLu7W0+TjqKrqyuxfo61Ld2BNY7dxLV98BF/HXzJXwdf8tfBl/xHHURHR4v1c2JiYsSyJBxK2h0dHaDuN1T9NpGRkTA9Pa2P7MCmTBpFaGgo3TT4eXZ2xnp9fT3k5+fD8/Mz10NCQuDk5ASmpqa4npWVxRpBKXN3d5dtH5zaUlNTjXxnYXR0lH0vLy+i2ElOTsbc3FypmbS3t/N3VPQi+0v2t7e3/PSXTmk0j4+PPFonfq+ONCVOfNFAw3ZCGhXbLU7wG0XEyMgIvL298a+iaJicnITDw0M4OjoCdYmStwxoBGFhYZzL1VTC3d0d26RR/ebmht/79Sh6t5MbGxtB3e/5lzjp6emBtrY2qdlpaWmB6upqqdnRK+6ksrKSdRWiopioWyD78vLyRDFRU6Xb/PQsonUgIiIi+GnFpyUmJvLTinX079agt7eXPxofH4fLy0tRAeLi4thH/2TGxsZENaA7bV9fH/uGh4dFNQjsIpeUlMD6+jrs7e3xL7LS1dUFm5ub7K+pqRHVoLW1lfXl5WUoKysT1YQXIz4+XpbIZGhoiH1NTU2imBQXF7NPRY8oJunp6eyTog1cWFiQVxDVdke1I1mPiorC4+Nj8SCurKzob9RORnWkiAdxa2tL+6gEfqPROeI8FnxQtPgLS4Iyor9zidDD2dnZkYEaZGdnsx4bG4tPT0+iIp6fn6PaB+xTecB2nJ+enur2pJgVJwMDA6xXVVWJYlJYWPihLycnR7epitlBUlISTkxM4NzcHDY3N1tfwtLSUpydncWZmRn0er02H3WyuLiI8/PzWFRUZPMFdpELCgpAhSDn1MHBQVEN6LTc2NiAtbU1qKurE9WgoaEBVldXYWlpCcrLy0U14aF4PB6ZQROVgNinGhTFpKKign21tbWimNDp62tXFW3wHPqgyFAhybo6VfHg4EA8iOrI0N/Q0axytngQ9/f3tY/9Yvwan+YDN/CokBPTfbxeL/wDUeva+z75IWIAAAAASUVORK5CYII=",
"contentType": "txt",
"fileName": "phone.txt"
}
]
},
"content": "Sample Content",
"description": "Sample Description",
"name": "Sample Suggestion",
"relatedArticle": {"id": 202200000002268
},
"customAttributes": {"customAttribute": [{"attribName": "custom_integer_attribute",
"attribValues": {"attribValue": [{"value": 8
}
]
}
},
{"attribName": "custom_string_attribute",
"attribValues": {"attribValue": [{"value": "fg"
}
]
}
}
]
}
}

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