Update a knowledge base

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.

Authorizations

Authorizationstringheaderrequired

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

Scope:knowledge-bases.write

Auth methods:OAuthPrivate Integration

Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3

Example:v3

Path Parameters

idstringrequired

The unique identifier of the knowledge base to update

Example:ve9EPM428h8vShlRW1KT

Body

application/json

namestring

field to update the name of the knowledge base

Example:My Updated Knowledge Base

descriptionstring

field to update the description of the knowledge base

Example:An updated description for this knowledge base

Response

200

application/json

Knowledge base updated successfully

successbooleanrequired

Indicates if the update operation was successful

Example:true