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}

Update document resource

cURL

curl --request PATCH \
  --url https://api.vanta.com/v1/knowledge-base/resources/documents/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "SOC 2 Type II (FY24)",
  "description": "Updated annual report",
  "downloadPermission": "VIEW_AND_DOWNLOAD",
  "isUsedInQuestionnaires": true
}
'

200

{
  "id": "507f1f77bcf86cd799439021",
  "type": "FILE",
  "title": "SOC 2 Type II Report",
  "description": "Annual SOC 2 Type II report covering 2024.",
  "fileUrl": "https://vanta-uploaded-documents.s3.amazonaws.com/507f1f77bcf86cd799439021?X-Amz-Expires=3600&X-Amz-Signature=...",
  "customerVisibility": "REQUEST_ACCESS",
  "downloadPermission": "VIEW_AND_DOWNLOAD",
  "isUsedInQuestionnaires": true,
  "ownerAssignment": {
    "type": "User",
    "id": "507f1f77bcf86cd799439041",
    "displayName": "Alex Rivera"
  },
  "expirationStatus": "CURRENT",
  "expirationDate": "2025-12-31T00:00:00.000Z",
  "lastUpdated": "2024-12-15T17:42:11.000Z",
  "lastVerified": "2024-12-20T09:00:00.000Z",
  "tags": [
    {
      "categoryId": "507f1f77bcf86cd799439011",
      "tagId": "507f1f77bcf86cd799439013"
    }
  ],
  "categoryId": "507f1f77bcf86cd799439051"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

Body

application/json

title · string

The title of the document resource.

Minimum string length: 1

description · string | null

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

ownerAssignment · object

The actor to assign as owner. Pass null to clear. Currently only type "User" is supported.

Show child attributes

customerVisibility · enum<string>

Customer visibility on the Trust Center.

Available options: PRIVATE, SHAREABLE, REQUEST_ACCESS, PUBLIC

downloadPermission · enum<string>

Trust Center download permission.

Available options: VIEW_ONLY, VIEW_AND_DOWNLOAD

isUsedInQuestionnaires · boolean

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

expirationDate · string | null

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

tags · object[]

Tags to associate with the resource. A non-empty array replaces the existing tag set; pass [] to clear all tags.

Show child attributes

categoryId · string | null

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

200 - application/json

Ok

id · string · required

type · enum<string> · required

Available options: FILE

title · string · required

description · string | null · required

fileUrl · string · 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 · enum<string> | null · required

Available options: PRIVATE, SHAREABLE, REQUEST_ACCESS, PUBLIC, null

downloadPermission · enum<string> | null · required

Available options: VIEW_ONLY, VIEW_AND_DOWNLOAD, null

isUsedInQuestionnaires · boolean | null · required

ownerAssignment · object · required

Show child attributes

expirationStatus · enum<string> · 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.

Available options: CURRENT, EXPIRED

expirationDate · string | null · required

lastUpdated · string · required

lastVerified · string | null · required

tags · object[] · required

Show child attributes

categoryId · string | null · 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).