> This page is for Developer Documentation.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.benchling.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.benchling.com/_mcp/server.

# Update PlateRecord

PATCH https://{tenant_name}.benchling.com/api/v3/plate-record/{plate_record_id}
Content-Type: application/json

Update PlateRecord.

Reference: https://docs.benchling.com/docs/api/benchling-api/plate-record/update

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Path parameters

- `plate_record_id` (string, required) — ID of the PlateRecord.

### Body (application/json)

This endpoint expects an object.

- `barcode` (string, optional) — Barcode to record as a plate field in the metadata layer.
- `concentrationLayers` (list of ConcentrationLayerInput, optional)
- `height` (integer, optional)
- `isHidden` (boolean, optional) — Whether the plate record is hidden from the plate's sidebar list.
- `metadataLayers` (list of MetadataColumnInput, optional)
- `name` (string, optional)
- `parameterLayers` (list of ParameterLayerInput, optional)
- `plateSchemaId` (string, optional, nullable)
- `storageId` (string, optional) — Inventory storage ID to record as a plate field in the metadata layer.
- `wells` (list of PlateRecordWellInput, optional)
- `width` (integer, optional)

## Response

### 200

OK

- `__typename` (string, optional)
- `barcode` (string, optional, nullable) — The plate's barcode, when one has been recorded.
- `createdAt` (string, optional, nullable)
- `height` (integer, optional)
- `id` (string, optional)
- `isHidden` (boolean, optional) — Whether the plate record is hidden from the plate's sidebar list.
- `layers` (list of PlateRecordLayer, optional)
- `modifiedAt` (string, optional, nullable)
- `name` (string, optional)
- `plateSchema` (PlateSchemaInterfaceRef, optional, nullable) — The plate schema associated with this plate record. Used as the default schema when converting to an inventory plate via `bulk-put-in-inventory`; can be overridden per-item in that call.
- `storageId` (string, optional, nullable) — The plate's storage location identifier, when one has been recorded.
- `width` (integer, optional)

## Errors

### 400 Plate Record Update Request Bad Request Error

Bad Request

- `detail` (GeneralErrorDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `invalidId` (string, optional)

### 403 Plate Record Update Request Forbidden Error

Forbidden

- `detail` (GeneralErrorDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `invalidId` (string, optional)

### 404 Plate Record Update Request Not Found Error

Not Found

- `detail` (GeneralErrorDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `invalidId` (string, optional)

### 409 Plate Record Update Request Conflict Error

Conflict

- `detail` (GeneralErrorDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `invalidId` (string, optional)

### 429 Plate Record Update Request Too Many Requests Error

Too Many Requests

- `detail` (TooManyRequestsErrorBodyDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `invalidId` (string, optional)
- `violated-policies` (list of enum, optional) — The budget policies that rejected the request, in canonical order: `user`, `integration`, then `tenant`.
  - Allowed values: `user`, `integration`, `tenant`

### 500 Plate Record Update Request Internal Server Error

Internal Server Error

- `detail` (InternalServerErrorBodyDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `errorId` (string, optional)

## Types

### ConcentrationLayerInput

- `concentrationUnitId` (string, required)
- `concentrationUnitVersionNumber` (integer, required)
- `name` (string, required)
- `wells` (list of ConcentrationWellInput, optional)

### MetadataColumnInput

- `name` (string, required)
- `type` (enum, required)
  - Allowed values: `text`, `integer`, `float`, `boolean`, `date`, `datetime`
- `plateValue` (MetadataColumnInputPlateValue, optional, nullable)
- `systemName` (string, optional)
- `wells` (list of MetadataWellInput, optional)

### ParameterLayerInput

- `fieldType` (enum, required)
  - Allowed values: `TEXT`, `FLOAT`, `DATETIME`
- `name` (string, required)
- `parameterVersionId` (string, required)
- `wells` (list of ParameterWellInput, optional)

### PlateRecordWellInput

- `columnIndex` (integer, required)
- `rowIndex` (integer, required)
- `roles` (list of WellRoleInput, optional)
- `sampleSchemaId` (string, optional)
- `schemaTags` (map from string to any, optional)
- `wellVolumeAmount` (double, optional)
- `wellVolumeUnitId` (string, optional)
- `wellVolumeUnitVersionNumber` (integer, optional)

### PlateRecordLayer

A named layer within a `PlateRecord`, each backed by its own `DataFrame`.

- `__typename` (string, optional)
- `dataFrame` (DataFrameRef, optional) — The DataFrame holding this layer's per-well data.
- `name` (string, optional)

### PlateSchemaInterfaceRef

- `__typename` (string, optional)
- `id` (string, optional)

### GeneralErrorDetail

### TooManyRequestsErrorBodyDetail

### InternalServerErrorBodyDetail

### ConcentrationWellInput

- `concentrationAmount` (double, required, nullable)
- `wellPosition` (string, required)

### MetadataColumnInputPlateValue

### MetadataWellInput

- `value` (MetadataWellInputValue, required, nullable)
- `wellPosition` (string, required)

### ParameterWellInput

- `value` (ParameterWellInputValue, required, nullable)
- `wellPosition` (string, required)

### WellRoleInput

- `role` (string, required)
- `group` (string, optional)
- `subrole` (string, optional)

### DataFrameRef

- `__typename` (string, optional)
- `id` (string, optional)

### MetadataWellInputValue

### ParameterWellInputValue

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "__typename": "__typename",
  "barcode": "barcode",
  "createdAt": "createdAt",
  "height": 1,
  "id": "id",
  "isHidden": true,
  "layers": [
    {
      "__typename": "__typename",
      "name": "name"
    }
  ],
  "modifiedAt": "modifiedAt",
  "name": "name",
  "plateSchema": {
    "__typename": "__typename",
    "id": "id"
  },
  "storageId": "storageId",
  "width": 1
}
```

**SDK Code**

```python
import requests

url = "https://{tenant_name}.benchling.com/api/v3/plate-record/plate_record_id"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://{tenant_name}.benchling.com/api/v3/plate-record/plate_record_id';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```