> 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 TestOrder

PATCH https://{tenant_name}.benchling.com/api/v3/test-order/{test_order_id}
Content-Type: application/json

Update an existing Test Order.

## Available updates

- `containerId`: Set a container, omit the field to leave it unchanged, or provide `null` to remove the association.
- `status`: Transitions must follow the Test Order lifecycle: `PENDING` → `IN_PROGRESS`, `CANCELLED`, or `BLOCKED`; `IN_PROGRESS` → `COMPLETED` or `INVALID`; and `BLOCKED` → `PENDING` or `CANCELLED`.



Reference: https://docs.benchling.com/docs/api/benchling-api/test-order/update

## Authentication

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

## Request

### Path parameters

- `test_order_id` (string, required) — ID of the TestOrder.

### Body (application/json)

This endpoint expects an UpdateTestOrderInput.

- `containerId` (string, optional, nullable) — Omit to leave unchanged, or provide `null` to remove the container association.
- `status` (enum, optional) — Status changes must follow the permitted Test Order lifecycle transitions.
  - Allowed values: `PENDING`, `BLOCKED`, `IN_PROGRESS`, `CANCELLED`, `INVALID`, `COMPLETED`

## Response

### 200

OK

- `__typename` (string, optional)
- `analysisComment` (string, optional, nullable) — Additional comments provided for a test order with a status of blocked, invalid, or canceled.
- `container` (ContainerRef, optional, nullable) — The container associated with the sample being tested in this test order
- `createdAt` (string, optional) — Timestamp of when the test order was created.
- `dilutionFactor` (integer, optional, nullable) — The dilution factor of the test order.
- `id` (string, optional) — The ID of the test order.
- `modifiedAt` (string, optional) — Timestamp of when the test order was last modified.
- `name` (string, optional) — The name of the test order.
- `plateWellAssociations` (list of TestOrderLinkedPlateWell, optional) — The plate wells this test order has been linked to.
- `procedure` (ProcedureRef, optional, nullable) — The Assay (Procedure) for which this Test Order is created. Since a Test Definition can be used in multiple Assays, this association ensures clarity on which template should be followed for the specific Test Order. It is necessary to establish this association prior to the Assay Run to avoid ambiguity.
- `procedureMethodExecutionInstance` (ProcedureMethodExecutionInstanceRef, optional, nullable) — The execution instance of the procedure method, linking the Test Order to the specific Assay Run to enable easy retrieval of all related Test Orders.
- `result` (ResultRef, optional, nullable) — The result of the test order.
- `retestSourceProcedureMethodExecutionInstance` (ProcedureMethodExecutionInstanceRef, optional, nullable) — The execution instance of the procedure method this retest order was created in the context of, linking the Test Order to the specific Assay Run to enable easy retrieval of all related Retest Orders.
- `sample` (EntityRef, optional) — The sample being tested in this test order
- `status` (enum, optional) — The status of the test order.
  - Allowed values: `PENDING`, `BLOCKED`, `IN_PROGRESS`, `CANCELLED`, `INVALID`, `COMPLETED`
- `testDefinition` (TestDefinitionRef, optional) — The test definition associated with this test order.

## Errors

### 400 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 Forbidden Error

Forbidden

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

### 404 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 Conflict Error

Conflict

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

### 429 Too Many Requests Error

Too Many Requests

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

### 500 Internal Server Error

Internal Server Error

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

## Types

### ContainerRef

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

### TestOrderLinkedPlateWell

Represents the association between a Test Order and a specific well position on a plate. When samples are plated for testing, this type captures which plate (`WellPlate`) and well position (`wellPosition`) the test order's sample has been placed in. A Test Order can be linked to multiple plate wells when the sample is distributed across multiple wells.

- `__typename` (string, optional)
- `plate` (WellPlateRef, optional) — The plate linked from the test order.
- `wellPosition` (string, optional) — Alphanumeric position of plate well eg. A1, B19

### ProcedureRef

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

### ProcedureMethodExecutionInstanceRef

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

### ResultRef

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

### EntityRef

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

### TestDefinitionRef

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

### GeneralErrorDetail

- string
- map from string to any

### TooManyRequestsErrorDetail

- string
- map from string to any

### InternalServerErrorDetail

- string
- map from string to any

### WellPlateRef

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

## Examples

**Request**

```json
{
  "containerId": "con_F6wN4sT2",
  "status": "IN_PROGRESS"
}
```

**Response**

```json
{
  "__typename": "string",
  "analysisComment": null,
  "container": {
    "__typename": "string",
    "id": "string"
  },
  "createdAt": "string",
  "dilutionFactor": null,
  "id": "string",
  "modifiedAt": "string",
  "name": "string",
  "plateWellAssociations": [
    {
      "__typename": "string",
      "plate": {
        "__typename": "string",
        "id": "string"
      },
      "wellPosition": "string"
    }
  ],
  "procedure": {
    "__typename": "string",
    "id": "string"
  },
  "procedureMethodExecutionInstance": {
    "__typename": "string",
    "id": "string"
  },
  "result": {
    "__typename": "string",
    "id": "string"
  },
  "retestSourceProcedureMethodExecutionInstance": {
    "__typename": "string",
    "id": "string"
  },
  "sample": {
    "__typename": "string",
    "id": "string"
  },
  "status": "PENDING",
  "testDefinition": {
    "__typename": "string",
    "id": "string"
  }
}
```

**SDK Code**

```python
import requests

url = "https://{tenant_name}.benchling.com/api/v3/test-order/test_order_id"

payload = {
    "containerId": "con_F6wN4sT2",
    "status": "IN_PROGRESS"
}
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/test-order/test_order_id';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"containerId":"con_F6wN4sT2","status":"IN_PROGRESS"}'
};

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