The Question Entries API manages FAQ questions and answers in the FAQ app. This API allows you to manage FAQ content that appears in a site's Wix FAQ widgets, helping site visitors find answers to common questions.
With the Question Entries API, you can:
- Create and manage question entries with multiple possible answer formats.
- Organize questions using categories and labels for better content structure.
- Perform bulk operations for efficient content management.
Question entries work together with the Categories API to create a complete FAQ management system. Categories provide the organizational structure, and question entries contain the actual FAQ content and must be assigned to categories. Question entries reference the category they belong to via categoryId
.
The Question Entries API supports 3 different answer formats to accommodate various content needs:
- Draft.js: Structured rich text format ideal for complex formatting and editing workflows.
- Rich Content: Advanced format supporting media, interactive elements, and sophisticated layouts.
- Plain Text: Simple text format for basic answers without special formatting.
It's important to note the following points before starting to code:
- The Wix user must install the FAQ app on their site.
- Question entries must be assigned to categories. Use the Categories API to create and manage categories first.
- Question entries: Individual FAQ content items, containing a question and its answer. The questions and answers appear in Wix FAQ widgets on a site.
- Categories: Themed groupings that organize question entries. For example, Shipping or Returns. Managed via the Categories API. Categories appear as sections in Wix FAQ widgets on a site, allowing visitors to browse questions by topic.
- Labels: Additional groupings of FAQ question entries. Labels aren't visible to site visitors, but are useful in specific contexts, such as chat bots.
- Share links: Direct URLs that link to specific question entries in the site's Wix FAQ widgets.