Skip to main content
PUT
https://app.famulor.de
/
api
/
user
/
knowledgebases
/
{knowledgebaseId}
/
documents
/
{documentId}
Dokument aktualisieren
curl --request PUT \
  --url https://app.famulor.de/api/user/knowledgebases/{knowledgebaseId}/documents/{documentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>"
}
'
{
  "message": "Document updated successfully.",
  "data": {
    "id": 1,
    "name": "Aktualisiertes Produkthandbuch",
    "description": "Überarbeitetes Benutzerhandbuch mit neuen Funktionen",
    "type": "pdf",
    "type_label": "PDF",
    "status": "active",
    "status_label": "Aktiv",
    "updated_at": "2025-01-08T15:45:00.000000Z"
  }
}
Dieser Endpunkt aktualisiert die Metadaten eines bestehenden Dokuments. Sie können nur den Namen und die Beschreibung aktualisieren - der Dokumenttyp und der Inhalt können nicht geändert werden.

Pfad-Parameter

knowledgebaseId
integer
required
Die eindeutige Kennung der Wissensdatenbank
documentId
integer
required
Die eindeutige Kennung des zu aktualisierenden Dokuments

Request Body

name
string
Der neue Name für das Dokument (max. 255 Zeichen)
description
string
Die neue Beschreibung für das Dokument (max. 255 Zeichen)

Antwort-Felder

message
string
Erfolgsmeldung
data
object
Das aktualisierte Dokument-Objekt
Um den Inhalt eines Dokuments zu aktualisieren, müssen Sie das bestehende Dokument löschen und ein neues mit dem aktualisierten Inhalt erstellen.
curl -X PUT "https://app.famulor.de/api/user/knowledgebases/1/documents/1" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Aktualisiertes Produkthandbuch",
    "description": "Überarbeitetes Benutzerhandbuch mit neuen Funktionen"
  }'
{
  "message": "Document updated successfully.",
  "data": {
    "id": 1,
    "name": "Aktualisiertes Produkthandbuch",
    "description": "Überarbeitetes Benutzerhandbuch mit neuen Funktionen",
    "type": "pdf",
    "type_label": "PDF",
    "status": "active",
    "status_label": "Aktiv",
    "updated_at": "2025-01-08T15:45:00.000000Z"
  }
}