Skip to main content

@wildix/wim-knowledge-base-client > UpdateDocumentInput

UpdateDocumentInput interface

Signature:

export interface UpdateDocumentInput 

Properties

Property

Modifiers

Type

Description

companyId?

string | undefined

(Optional) The unique identifier of the tenant when a service token is used.

content?

string | undefined

(Optional) Optional document content in plain text or markdown format. For file uploads, can be the document content.

dataSourceId

string

Unique identifier of the data source

description?

string | undefined

(Optional) Optional detailed description of the document content and purpose. Helps users understand what the document is about.

documentId

string

Unique identifier of the document

title?

string | undefined

(Optional) Display title of the document used in search results and UI. Can differ from originalName. Examples: 'Product Installation Guide', 'API Documentation'. Length: 2-100 characters

updatedAt?

string | undefined

(Optional) Timestamp when the document was last updated (ISO 8601 format). Example: 2021-01-01T00:00:00Z

url?

string | undefined

(Optional) Optional URL where the document can be accessed or viewed. Used for providing direct links to the source. Example: https://confluence.company.com/wiki/Product\_Documentation