Create or update a help center FAQ

POST

/api/v1/help-center/faqs

Create an FAQ, or update an existing one by passing its faqId.

Notes

• faq.websiteId must be set in the body as well as in the x-website-id header, and faq.categoryId must name an existing category
• You supply the question, not the answer. The FAQ is stored with answerStatus: pending and the AI generates the answer from the training data
• The URL slug is derived from the question and kept unique within the category. An existing FAQ keeps its slug when the question is edited; pass slug explicitly to override
• generationPrompt steers how the answer is written
• Changes only reach visitors after POST /api/v1/help-center/publish
• Deleting an FAQ is not available with an API key, only from the dashboard

Parameters

Header Parameters

x-api-key

required

string

Your API key from account settings.

x-user-email

required

string

The email address of your user.

x-account-id

required

string

The ID of your account. You can find this in the account settings.

x-website-id

required

string

The ID of the workspace you want to use.

Request Body ^required

object

faq

required

object

faqId

ID of an existing FAQ to update. Omit to create a new one.

string

question

required

string

categoryId

required

string

websiteId

required

string

generationPrompt

Extra instruction for the AI writing the answer.

string

nullable

order

Sort position within the category. Defaults to 0.

number

slug

URL slug. Derived from the question when omitted.

string

Example

{
  "faq": {
    "question": "How long is the refund window?",
    "categoryId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "websiteId": "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy",
    "generationPrompt": "Answer in two sentences and mention the contact form."
  }
}

Responses

200

The stored FAQ, with answerStatus set to pending.

400

Bad request - missing websiteId, question, categoryId or FAQ websiteId.

401

Unauthorized - invalid API key.