Skip to navigation

Create FAQ Category

View as Markdown

Creates a faq category. Needs a key with Website Content: Read and Write (website-content:write).

FieldTypeRules
namestringRequired, max 255, unique within the website.
sortinteger0–1,000,000.
faqsarrayUp to 200 questions.
faqs.*.questionstringRequired, max 5000.
faqs.*.answerstring|nullHTML, max 100,000.
faqs.*.slugstring|nullMax 255, ^[A-Za-z0-9]+(?:[-_][A-Za-z0-9]+)*$. Defaults to the slug of the question.

Sending faqs replaces the category’s questions by position: question 1 updates stored question 1, extra stored questions are removed, and new ones are added, each sorted by its position. Leave faqs out to keep the questions as they are. Two questions with the same slug in one payload, or a slug another category of the website already uses, return 422.

If a faq category with the same name already exists, this returns 422. Use Upsert FAQ Category when you do not know whether it exists.

Headers

GorillaDash-Api-KeystringOptional
Gorilla Dash API Key
GorillaDash-Api-SecretstringOptional
Gorilla Dash API Secret

Request

This endpoint expects an object.
namestringRequired
sortintegerRequired
faqslist of objectsRequired

Response

Created
successboolean
statusinteger
dataobject

Errors

403
Forbidden Error