FruxonDocs
ApiKnowledge bases

Updates a document (title, body, status, locale, tags, metadata).

Updates the authoring copy in place. Changes affect search results only after the parent knowledge base is published again. Publishing a document with knowledge from a conversation held during a knowledge notice (`metadata.extractedDuringNotice`) needs `noticeDecision=STILL_TRUE` and a `noticeDecisionReason`; without them it is refused with 409 `notice_decision_required`. Restoring the version agents are already served is not refused. The notice keys in `metadata` cannot be set or cleared here.

PATCH
/v1/tenants/{tenant}/knowledgeBases/{knowledgeBase}/documents/{document}

Authorization

Bearer
AuthorizationBearer <token>

JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token.

In: header

Path Parameters

knowledgeBase*string

The knowledge base id.

Formatuuid
document*string

The document id.

Formatuuid
tenant*string

The tenant identifier

Request Body

Document fields to replace. Null properties are left unchanged.

title?string|null
bodyMarkdown?string|null
status?string
Value in"UNSPECIFIED" | "DRAFT" | "PUBLISHED" | "ARCHIVED"
locale?string|null
tags?|null
metadata?|null
sourceConversationIds?|null
noticeDecision?string

Publishing a document that has knowledge from a conversation held during a knowledge notice (metadata.extractedDuringNotice) needs a decision: STILL_TRUE with UpdateKnowledgeDocumentRequest.NoticeDecisionReason publishes it as an article. The other two answers are archiving it and :becomeNotice. Ignored on any other update.

Value in"UNSPECIFIED" | "STILL_TRUE"
noticeDecisionReason?string|null

Why the knowledge holds after the incident; required with UpdateKnowledgeDocumentRequest.NoticeDecision, at most 256 characters.

[key: string]?never

Response Body

curl -X PATCH "https://api.fruxon.com/v1/tenants/string/knowledgeBases/497f6eca-6276-4993-bfeb-53cbbbba6f08/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "00000000-0000-0000-0000-000000000000",
  "knowledgeBaseId": "00000000-0000-0000-0000-000000000000",
  "title": "string",
  "bodyMarkdown": "string",
  "status": "DRAFT",
  "locale": "string",
  "tags": [
    "string"
  ],
  "metadata": {},
  "sourceConversationIds": [
    "string"
  ],
  "lastReviewedAt": 0,
  "lastReviewedBy": "string",
  "createdAt": 0,
  "modifiedAt": 0,
  "contentRevision": 0,
  "liveVersion": {
    "title": "string",
    "bodyMarkdown": "string"
  },
  "lastChange": {
    "cause": "AUTHORED",
    "actorId": "string",
    "agentId": "string",
    "at": 0
  }
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
Empty
Empty
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}