Create a new FAQ inside knowledge base

POST 
/knowledge-bases/faqs

Creates a new question-and-answer entry in a knowledge base. WHEN TO USE: use this when you need to add a brand-new FAQ; use update to change an existing one; use list to see current FAQs. RETURNS: success and the created FAQ, including its server-assigned id.

Request

Version stringrequired

API Version

Available optionsv3

application/json

application/json

Body

Bodyrequired

locationIdstringrequired

location ID as string

questionstringrequired

faq question as a string

answerstringrequired

faq answer as a string

knowledgeBaseIdstringrequired

knowledge base ID as string

Example (auto)

{
  "locationId": "HqDZpF8GH3qvgJTmKCoL",
  "question": "What is the capital of France?",
  "answer": "The capital of France is Paris.",
  "knowledgeBaseId": "710KoEzy793Fxubft0bc"
}

application/json

FAQ created successfully

application/json

Schema

Schema

successbooleanrequired

Success status of the operation

faqobjectrequired

Created FAQ details

Example (auto)

{
  "success": true,
  "faq": {}
}