Update document

Update a document's name or description

Updated 25 Jan 2026

On this page

This endpoint updates the metadata of an existing document. You can only update the name and description - the document type and content cannot be changed.

Path Parameters

knowledgebaseIdintegerrequired

The unique identifier of the knowledgebase

documentIdintegerrequired

The unique identifier of the document to update

Request Body

namestring

The new name for the document (max 255 characters)

descriptionstring

The new description for the document (max 255 characters)

Response

messagestring

Success message

dataobject

The updated document object

idinteger

  The unique identifier of the document

namestring

  The name of the document

descriptionstring

  Description of the document

typestring

  Document type

type_labelstring

  Human-readable type label

statusstring

  Processing status

status_labelstring

  Human-readable status label

updated_atstring

  ISO 8601 timestamp of last update

{
  "message": "Document updated successfully.",
  "data": {
    "id": 1,
    "name": "Updated Product Manual",
    "description": "Revised user guide with new features",
    "type": "pdf",
    "type_label": "PDF",
    "status": "active",
    "status_label": "Active",
    "updated_at": "2025-01-08T15:45:00.000000Z"
  }
}

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

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

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

To update the content of a document, you need to delete the existing document and create a new one with the updated content.