Update vault object

PATCH

vault

{id}

objects

{objectId}

{
  "id": "obj_abc123",
  "vaultId": "vault_def456",
  "filename": "deposition-smith-2024.pdf",
  "path": "/Discovery/Depositions",
  "contentType": "application/pdf",
  "sizeBytes": 2048576,
  "ingestionStatus": "completed",
  "metadata": {
    "client": "Smith & Associates"
  },
  "updatedAt": "2024-01-15T10:30:00Z"
}

Authorizations

Authorization

string

header

required

API key starting with sk_case_

Path Parameters

string

required

Vault ID

objectId

string

required

Object ID to update

Body

application/json

filename

string

New filename for the document (affects display name and downloads)

path

string | null

Folder path for hierarchy preservation (e.g., '/Discovery/Depositions'). Set to null or empty string to remove.

metadata

object

Additional metadata to merge with existing metadata

Response

Object updated successfully

string

Object ID

vaultId

string

Vault ID

filename

string

Updated filename

path

string | null

Folder path for hierarchy preservation

contentType

string

MIME type

sizeBytes

integer

File size in bytes

ingestionStatus

string

Processing status

metadata

object

Full metadata object

updatedAt

string<date-time>

Last update timestamp

Append PDF vault objects onto an existing PDF vault objectMerges one or more PDF vault objects onto the end of an existing PDF vault object, overwriting the target in place before returning. Optionally rewrites citation links in the original target into internal PDF jumps and adds back links on appended pages. The target object’s ingestion state is not affected; appended pages are not searchable.

⌘I

{
  "id": "obj_abc123",
  "vaultId": "vault_def456",
  "filename": "deposition-smith-2024.pdf",
  "path": "/Discovery/Depositions",
  "contentType": "application/pdf",
  "sizeBytes": 2048576,
  "ingestionStatus": "completed",
  "metadata": {
    "client": "Smith & Associates"
  },
  "updatedAt": "2024-01-15T10:30:00Z"
}