Sign in

v1

latestOpenAPI 3.0.3MIT OR Apache-2.02026-07-17203670.3 KB
documents

Update a document

Partially updates a document's title, table assignment, tags, or metadata. Only provided fields are changed. metadata is merged key-by-key, not replaced wholesale.

patch/v1/documents/{id}

Path parameters

idstring required
Example:doc_abc123

Document ID

Request body

titlestring

Updated document title

table_idstring

Move document to a different table

tagsstring[]

Document tags (replaces existing tags)

metadataobject

Metadata to merge (key-by-key, not replaced wholesale)

Example request

{
  "title": "NDA Agreement - Updated",
  "table_id": "tbl_archived",
  "tags": [
    "nda",
    "archived"
  ],
  "metadata": {
    "reviewed_by": "Legal Team",
    "status": "archived"
  }
}

Response

Document updated

updatedboolean
document_idstring

Example response

{
  "updated": true,
  "document_id": "doc_abc123"
}