Update knowledgebase

Update an existing knowledgebase

Updated 25 Jan 2026

On this page

This endpoint updates the name and/or description of an existing knowledgebase.

Path Parameters

idintegerrequired

The unique identifier of the knowledgebase to update

Request Body

namestring

The new name for the knowledgebase (max 255 characters)

descriptionstring

The new description for the knowledgebase (max 255 characters)

Response

messagestring

Success message

dataobject

The updated knowledgebase object

idinteger

  The unique identifier of the knowledgebase

namestring

  The name of the knowledgebase

descriptionstring

  Description of the knowledgebase

statusstring

  Current status

status_labelstring

  Human-readable status label

updated_atstring

  ISO 8601 timestamp of last update

{
  "message": "Knowledgebase updated successfully.",
  "data": {
    "id": 1,
    "name": "Updated Product Documentation",
    "description": "Updated description for our technical docs",
    "status": "active",
    "status_label": "Active",
    "updated_at": "2025-01-08T15:45:00.000000Z"
  }
}

{
  "error": "Knowledgebase not found."
}

{
  "message": "The name may not be greater than 255 characters.",
  "errors": {
    "name": [
      "The name may not be greater than 255 characters."
    ]
  }
}

Updating a knowledgebase's name or description does not affect its documents or processing status.