Update an unstructured table | Benchling Documentation

curl -X PATCH https://{tenant_name}.benchling.com/api/v3/document-part-unstructured-table/doc_part_id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "versionId": "etrver_Ax7b2kR9",
  "columnDefinitions": [
    {
      "name": "Sample ID"
    },
    {
      "name": "Value"
    }
  ],
  "rows": [
    {
      "cells": [
        {
          "inputValue": {
            "type": "text_value",
            "value": "SMPL_001"
          }
        },
        {
          "inputValue": {
            "type": "text_value",
            "value": "='\''DataTable'\''!A1 * 100"
          },
          "format": {
            "backgroundColor": "#FDC68A"
          }
        }
      ]
    },
    {
      "cells": [
        {
          "inputValue": {
            "type": "text_value",
            "value": "SMPL_002"
          },
          "format": {
            "link": "https://benchling.com/"
          }
        },
        {
          "inputValue": {
            "type": "text_value",
            "value": "124.600"
          }
        }
      ]
    }
  ]
}'

{
  "__typename": "__typename",
  "caption": {
    "__typename": "__typename",
    "formats": [
      {}
    ],
    "links": [
      {}
    ],
    "mentions": [
      {}
    ],
    "text": "text"
  },
  "columnDefinitions": [
    {
      "__typename": "__typename",
      "isLocked": true,
      "name": "name",
      "width": 1.1
    }
  ],
  "createdAt": "createdAt",
  "documentParent": {
    "__typename": "__typename",
    "id": "id"
  },
  "id": "id",
  "indentation": 1,
  "isEvaluated": true,
  "modifiedAt": "modifiedAt",
  "modifier": {
    "__typename": "__typename",
    "id": "id"
  },
  "name": "name",
  "rowCount": 1,
  "rows": [
    {
      "__typename": "__typename",
      "cells": [
        {}
      ],
      "rowIndex": 1
    }
  ],
  "versionMetadata": {
    "__typename": "__typename",
    "createdAt": "createdAt",
    "versionId": "versionId"
  }
}

Deprecated. Use the document partsMutation operations instead:

To edit cell content, use the update_table_cells operation.
To append rows, use the insert_table_rows operation.
To change columns or merged cells, delete the table with the delete operation and re-create it with the updated data using the insert operation.

Update an unstructured table’s column definitions and cell content. All row and column indices in this endpoint are 0-based. Both columnDefinitions and rows are optional; omitting either preserves the existing values. When provided, they fully replace the existing values with no per-field carry-forward. Cells in locked columns cannot be modified; lock enforcement uses the post-mutation column state, so unlocking a column and editing its cells can be done in a single request. When adding rows to a table with locked columns, the new rows’ locked-column cells must be empty. Requires versionId for optimistic concurrency; returns 409 on stale version. Returns 400 if the document part is not an unstructured table or validation fails.

Authentication

AuthorizationBearer

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

Path parameters

doc_part_idstringRequired

Request

This endpoint expects an object.

versionIdstringRequired

The document's current version ID from versionMetadata.versionId in the last GET response. Required for optimistic concurrency.

captionobject or nullOptional

The table's caption. Omit to preserve the existing caption. Set to null to clear the caption.

columnDefinitionslist of objectsOptional

Column definitions for the table. Omit to preserve existing columns. When provided, fully replaces all column definitions; omitted fields on each column definition default to null (not the existing value).

namestringOptional

Display name of the table. Must be non-empty, at most 100 characters, and unique within the document. Omit to preserve the existing name.

rowslist of objectsOptional

Row data for the table. Omit to preserve existing rows. When provided, fully replaces all rows with no per-cell carry-forward of format, selectorId, or other fields from the existing table.

Response

Updated unstructured table content

__typenamestringOptional

captionobject or nullOptional

Specifies the rich text caption displayed with the table. Null if the table has no caption.

columnDefinitionslist of objectsOptional

Lists column definitions for the table.

createdAtstringOptional

Timestamp inherited from the document content backing this part. For entry and document content, this can reflect when the containing document was created, not when the DocumentPart identifier was created.

documentParentobjectOptional

idstringOptional

Identifies the document part.

indentationintegerOptional

Specifies the indentation level for this content within the document.

isEvaluatedbooleanOptional

Specifies whether formula evaluation has been applied to the table.

modifiedAtstringOptional

Specifies when this document part was last modified.

modifierobject or nullOptional

Identifies who last modified this document part.

namestringOptional

Specifies the display name of the table.

rowCountintegerOptional

Specifies the number of rows in the table.

rowslist of objectsOptional

Lists rows in the table, each containing an ordered array of cells.

versionMetadataobjectOptional

Specifies version metadata for the parent document.

Errors

400

Document Part Unstructured Table Update Request Bad Request Error

403

Document Part Unstructured Table Update Request Forbidden Error

404

Document Part Unstructured Table Update Request Not Found Error

409

Document Part Unstructured Table Update Request Conflict Error

429

Document Part Unstructured Table Update Request Too Many Requests Error

500

Document Part Unstructured Table Update Request Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors