Update a knowledge base

PUT 
/knowledge-bases/:id

Updates the name and/or description of an existing knowledge base. WHEN TO USE: use this when you need to rename or re-describe a knowledge base; use createKnowledgeBase to add one; use deleteKnowledgeBase to remove one. RETURNS: whether the update succeeded.

Request

Version stringrequired

API Version

Available optionsv3

id stringrequired

The unique identifier of the knowledge base to update

application/json

application/json

Body

Bodyrequired

namestring

field to update the name of the knowledge base

descriptionstring

field to update the description of the knowledge base

Example (auto)

{
  "name": "My Updated Knowledge Base",
  "description": "An updated description for this knowledge base"
}

application/json

Knowledge base updated successfully

application/json

Schema

Schema

successbooleanrequired

Indicates if the update operation was successful

Example (auto)

{
  "success": true
}