Knowledge Base
Update Knowledge Base
Update a knowledge base name or settings.
PATCH
Update Knowledge Base
Changes state - verify before retry
Update a knowledge base. Today this changes its
Fetch the same
name. The new name must be unique within your workspace and at most 150 characters; this route does not check the length up front, so a longer name fails with 500 Internal Server Error instead of 400.
When to use this
- Renaming: keep knowledge base names aligned with the product line or customer they cover as those names change on your side.
- Naming conventions: bring older knowledge bases in line with a naming scheme so pickers stay readable.
id. A 400 Bad Request means the new name is blank; a 409 Conflict means another knowledge base in the workspace already has that name, or a document in this knowledge base is still being indexed (retry once it finishes). See API errors for the standard error format.
kb_ ID after the update and confirm the name changed. If the request timed out, read the resource before retrying.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Knowledge base ID
Example:
"kb_abc123"
Body
application/json
Knowledge base name. Must not be blank when provided. Keep it to 150 characters: a longer name is refused with 500.
Pattern:
\SExample:
"Updated Product Documentation"