Skip to navigation

Knowledge · Rename or re-describe a knowledge base

View as Markdown

Updates the title or description. Contents are managed through the source operations; there is nothing to change here that affects what a search returns.

Authentication

AuthorizationApi-Key

Header authentication of the form Api-Key <token>

OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

knowledge_base_idstringRequired
Knowledge base UUID.

Request

This endpoint expects an object.
titlestringOptional
Display name, e.g. "Product documentation".
descriptionstringOptional
One line on what the knowledge base holds. Shown in pickers.

Response

The updated knowledge base.

Errors

404
Not Found Error