VAvanta
Knowledge Base

Update document resource

Apply a partial update to a document (FILE-type) resource. Omitted fields are left untouched. To swap the underlying file, use POST /v1/knowledge-base/resources/documents/{id}/upload. Returns 404 for an unknown id or a URL-type resource.

patch/knowledge-base/resources/documents/{id}

Request

Path parameters

idstring required

Request body

titlestring

The title of the document resource.

descriptionstring nullable

A description for the document resource. Pass null to clear.

customerVisibility'PRIVATE' | 'SHAREABLE' | 'REQUEST_ACCESS' | 'PUBLIC'

Customer-facing visibility of a knowledge-base resource on the Trust Center. Use {@link CUSTOMER_VISIBILITY_TO_DB} to translate to {@link TrustCenterResourceVisibility} when persisting.

downloadPermission'VIEW_ONLY' | 'VIEW_AND_DOWNLOAD'

Customer-facing download permission for a knowledge-base resource on the Trust Center. Use {@link DOWNLOAD_PERMISSION_TO_DB} to translate to {@link TrustKnowledgeBaseResourceDownloadSetting} when persisting.

isUsedInQuestionnairesboolean

Whether the resource should be used for question-answering in Questionnaire Automation.

expirationDatestring nullable

Expiration date in ISO 8601 format. Pass null to clear.

categoryIdstring nullable

Trust Center category id to associate this resource with. Pass null to move the resource to uncategorized. Only valid when the resource's effective visibility (after applying any patched customerVisibility) is REQUEST_ACCESS or PUBLIC; other combinations and unknown ids return an InvalidInputError.

Response

Ok

idstring required
type'FILE' required
titlestring required
descriptionstring nullable required
fileUrlstring required

Presigned S3 URL for the underlying document. Expires after 1 hour due to AWS IAM Role limitations on presigned URL lifetimes. Re-fetch the resource to obtain a fresh URL once this one expires.

customerVisibility'PRIVATE' | 'SHAREABLE' | 'REQUEST_ACCESS' | 'PUBLIC' | 'null' nullable required
downloadPermission'VIEW_ONLY' | 'VIEW_AND_DOWNLOAD' | 'null' nullable required
isUsedInQuestionnairesboolean nullable required
expirationStatus'CURRENT' | 'EXPIRED' required

Customer-facing expiration status used by knowledge-base API responses (answer library entries and resources). Derived from the persisted expiresAt field at read time.

expirationDatestring nullable required
lastUpdatedstring required
lastVerifiedstring nullable required
categoryIdstring nullable required

Trust Center category id the resource is currently filed under, or null if uncategorized (or not on the Trust Center, which is the case for PRIVATE / SHAREABLE resources).

Changes

No recorded changes to this operation across all 1 revision of this API.