Update knowledge base

Interface Description

Update the name or description of one knowledge base. Send its current resourceRevision in If-Match; the updated record is returned after the change is saved.

Endpoint

Field	Value
Method	PATCH
Path	/openapi/v2/knowledge-bases/{knowledgeBaseId}
Operation ID	updateKnowledgeBase
Authentication	Bearer OpenAPI key

Parameters

Name	Location	Required	Type	Example	Description
knowledgeBaseId	path	Yes	string	knowledge-base-11111111-1111-4111-8111-111111111111	Knowledge-base identifier returned by knowledge-base APIs.
If-Match	header	Yes	string	"1"	Current resourceRevision returned by the API. If the resource changed after it was read, the request returns a conflict instead of overwriting the newer change.

Request Body

application/json

Field	Required	Type	Example	Description
name	No	string	Product handbook	Human-readable resource name, limited to 255 UTF-8 bytes.
description	No	string | null	Current product guidance.	Updated description or null to clear it, limited to 16384 UTF-8 bytes.

Request Example

curl -X PATCH "https://openapi.example.com/openapi/v2/knowledge-bases/knowledge-base-11111111-1111-4111-8111-111111111111" \
  -H "Authorization: Bearer <openapi-key>" \
  -H "If-Match: \"1\"" \
  -H "Content-Type: application/json" \
  --data '{
  "name": "Product handbook",
  "description": "Current product guidance."
}'

Successful Responses

200

Updated knowledge-base record.

Field	Required	Type	Description
knowledgeBase	Yes	object	Knowledge base returned by the request.

Success Response Example

{
  "knowledgeBase": {
    "knowledgeBaseId": "knowledge-base-11111111-1111-4111-8111-111111111111",
    "name": "Product Docs",
    "description": "Product documentation",
    "activeContentRevision": 1,
    "resourceRevision": 1,
    "createdAt": "2026-06-17T00:00:00.000Z",
    "updatedAt": "2026-06-17T00:00:00.000Z"
  }
}

Error Codes

The table below lists every error response documented for this operation.

HTTP Status	Error Code	Explanation
401	UNAUTHORIZED	The Bearer API key is missing, malformed, unknown, revoked, or deleted.
404	NOT_FOUND	The requested resource was not found.
409	CONFLICT	The request conflicts with the resource's current state.
413	PAYLOAD_TOO_LARGE	The request body or requested file exceeds the size limit for this operation.
422	VALIDATION_ERROR	The request failed validation.
429	RATE_LIMITED	The request exceeded the configured rate limits.
500	INTERNAL_ERROR	The API encountered an internal error.
503	DATABASE_REPOSITORY_UNAVAILABLE	The data required by this operation is temporarily unavailable.

Next Steps

• Get knowledge base