Sign in
Knowledge Base

Update record

Update a record's name and/or file content.

Overview:

Allows updating the display name and optionally replacing the file content. Triggers re-indexing when content changes.

Required permission:

WRITER or higher

Updating file content:

Include a new file in the request to replace the existing content. The file extension must match the original.

Side effects:

  • Updates updatedAtTimestamp
  • Increments version if file content changed
  • Triggers re-indexing for content changes
put/knowledgeBase/record/{recordId}

Path parameters

recordIdstring required

Record ID

Response

Record updated successfully

successboolean
messagestring
timestampinteger

Epoch milliseconds when the response was generated

fileUpdatedboolean
location'kb_root' | 'folder'
kbobject
userPermissionstring

Example response

{
  "record": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "recordName": "Q4 Financial Report.pdf",
    "externalRecordId": "507f1f77bcf86cd799439011",
    "recordType": "FILE",
    "origin": "UPLOAD",
    "connectorId": "conn_123456",
    "connectorName": "DRIVE",
    "orgId": "org_abc123",
    "kbId": "kb_xyz789",
    "folderId": "folder_456",
    "version": 3,
    "createdAtTimestamp": 1704153600000,
    "updatedAtTimestamp": 1704240000000,
    "parsingStatus": "COMPLETED",
    "indexingStatus": "COMPLETED",
    "webUrl": "https://drive.google.com/file/d/abc123",
    "mimeType": "application/pdf",
    "sizeInBytes": 1048576,
    "extension": "pdf",
    "type": "record"
  }
}

Changes

Changed in 3 of the 15 revisions of this API.10

  • 5798f431973a2See the full diff
    • ○

      added the optional property allOf[subschema #1]/record/parsingStatus to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #1]/record/processingStartedAt to the response with the 200 status

      response-optional-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 059c619e9b997See the full diff
    • ○

      the endpoint scheme security oauth2 was added to the API

      api-security-added

    • ○

      added the media type application/json for the response with the status 400

      response-media-type-added

    • ○

      added the media type application/json for the response with the status 401

      response-media-type-added

    • ○

      added the media type application/json for the response with the status 403

      response-media-type-added

    • ○

      added the media type application/json for the response with the status 404

      response-media-type-added

    • ○

      added the non-success response with the status 500

      response-non-success-status-added

    • ○

      added the non-success response with the status 503

      response-non-success-status-added

  • 911a57b55d181See the full diff
    • ○

      endpoint added

      endpoint-added