Company logoTrust Center Documentation
API v1 ReferenceKnowledge baseId

Update Q&A item

Update a knowledge base Q&A item. When `locale` is omitted or resolves to the tenant default locale, base item fields are updated. When `locale` is a…

PATCH
/api/v1/knowledge-base/{id}

Update a knowledge base Q&A item. When locale is omitted or resolves to the tenant default locale, base item fields are updated. When locale is a non-default enabled language, only localized question, answer, and answer_md content is updated; shared fields such as tags and access_level remain controlled by the base item. Send intent=delete_translation with a non-default locale to remove that localized content.

Authorization

bearerAuth
AuthorizationBearer <token>

API key generated in Admin Center Integrations

In: header

Path Parameters

id*string

Q&A item ID

Length1 <= length

Header Parameters

x-locale?string

Alternative locale selector when locale is not present in the query string or body.

Value in"en" | "de" | "fr"

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/v1/knowledge-base/kb-123" \  -H "Content-Type: application/json" \  -d '{    "locale": "en",    "question": "What security certifications and compliance standards do you maintain?",    "answer": "We maintain SOC 2 Type II, ISO 27001, and GDPR compliance certifications.",    "answer_md": "We maintain **SOC 2 Type II**, **ISO 27001**, and GDPR compliance certifications.",    "access_level": "public",    "tags": [      "security",      "compliance"    ]  }'

{
  "success": true,
  "data": {
    "id": "kb-123",
    "question": "What security certifications and compliance standards do you maintain?",
    "answer": "We maintain SOC 2 Type II, ISO 27001, and GDPR compliance certifications.",
    "answer_md": "We maintain **SOC 2 Type II**, **ISO 27001**, and GDPR compliance certifications.",
    "access_level": "public",
    "tags": [
      "security",
      "compliance"
    ]
  }
}

{
  "error": "The knowledge base ID provided is not valid."
}

{
  "error": "Unauthorized"
}
{
  "error": "Forbidden"
}
{
  "error": "Knowledge base item not found."
}
{
  "error": "Internal server error"
}

How is this guide?