Get Suggested FAQs
GET https://api.helpshift.com/v1/{{domain}}/faqs/suggest?text=locked account
Suggest FAQs based on the input text by the user.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
text | string | The input text used to suggest FAQs. | |
app-id | string | The app from whichto select FAQs. Please refer to the ‘Get Apps’ and ‘Get App Data’ call to get a specific app-id. | |
platform-type | string | Optional - suggest FAQs visible or the given platform only. Valid value is “ios”, “android”, “email”, “web” or “webchat”. | |
language | string | Optional - currently only "en" is supported, and is the default if not provided. | |
include-unpublished? | boolean | If true, the suggested FAQs will include unpublished FAQs which match the search term. If false (the default), only published FAQs are included in the list of suggested FAQs. |