Company logoTrust Center Documentation
API v1 ReferenceKnowledge baseId

Update Q&A item

Update a knowledge base Q&A item's content or metadata

PATCH
/api/v1/knowledge-base/{id}
AuthorizationBearer <token>

JWT token obtained from login endpoint

In: header

Path Parameters

idstring

Q&A item ID

Formatuuid
question?string

Updated question text

answer?string

Updated answer text

category?string

Updated category

featured?boolean

Whether to feature this item

order?integer

Display order (lower numbers appear first)

Response Body

const body = JSON.stringify({  "answer": "We maintain SOC 2 Type II, ISO 27001, ISO 27018, and GDPR compliance certifications. All certifications are renewed annually.",  "featured": true})fetch("https://app.orbiqhq.com/api/v1/knowledge-base/550e8400-e29b-41d4-a716-446655440000", {  method: "PATCH",  headers: {    "Content-Type": "application/json"  },  body})
{
  "success": true,
  "data": {
    "item": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "question": "What security certifications do you have?",
      "answer": "We maintain SOC 2 Type II, ISO 27001, ISO 27018, and GDPR compliance certifications. All certifications are renewed annually.",
      "category": "Security",
      "featured": true,
      "order": 1,
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-25T14:00:00Z"
    }
  }
}
{
  "error": "Invalid request parameters"
}
{
  "error": "Unauthorized"
}
{
  "error": "Q&A item not found"
}
{
  "error": "Internal server error"
}

How is this guide?