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

# Batch update AppSession

PATCH https://{tenant_name}.benchling.com/api/v3/app-session:batch-update
Content-Type: application/json

Batch update AppSession synchronously in one transaction. Maximum 25 items per request.

Reference: https://docs.benchling.com/docs/api/benchling-api/app-session/batchupdate

## Authentication

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

## Request

### Headers

- `EARLY-ACCESS` (string, optional) — Set to true to access beta operations via /api/v3.

### Body (application/json)

This endpoint expects an object.

- `items` (list of UpdateAppSessionInputWithPathParams, required)

## Response

### 200

OK

- `items` (list of AppSession, required)

## Errors

### 400 App Session Batch 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 App Session Batch 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 App Session Batch 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 App Session Batch 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 App Session Batch 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 App Session Batch 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

### UpdateAppSessionInputWithPathParams

- `id` (string, required)
- `messages` (list of AppSessionMessageInput, optional) — Replace the current messages with this list. If omitted, the existing messages are carried forward unchanged.
- `status` (enum, optional) — Transition the session to a terminal status (SUCCEEDED, FAILED, or COMPLETED_WITH_WARNINGS).
  - Allowed values: `SUCCEEDED`, `FAILED`, `COMPLETED_WITH_WARNINGS`
- `timeoutSeconds` (integer, optional) — New timeout in seconds. Must be greater than or equal to the current timeout.

### AppSession

Represents a running or completed session for a Benchling App. App sessions track long-running app operations, providing status updates and user-facing messages. Each session belongs to a single app installation and progresses through a lifecycle from RUNNING to a terminal status. Sessions are updated by appending new versions, which can change the status, timeout, and displayed messages.

- `__typename` (string, optional)
- `app` (IAppInstallationRef, optional) — The Benchling App installation that owns this session.
- `createdAt` (string, optional)
- `id` (string, optional)
- `messages` (list of AppSessionMessage, optional) — The messages currently displayed to the user, from the most recent session version.
- `modifiedAt` (string, optional)
- `name` (string, optional)
- `status` (enum, optional) — The current lifecycle status of this session, derived from the most recent version.
  - Allowed values: `RUNNING`, `SUCCEEDED`, `FAILED`, `COMPLETED_WITH_WARNINGS`, `TIMEOUT`
- `timeoutSeconds` (integer, optional) — Maximum duration in seconds before the session times out automatically. Once the session's age exceeds this value and the session has not been finalized, its status becomes TIMEOUT.

### GeneralErrorDetail

### TooManyRequestsErrorBodyDetail

### InternalServerErrorBodyDetail

### AppSessionMessageInput

- `content` (string, required)
- `style` (enum, optional) — Visual style for this message. Defaults to NONE if omitted.
  - Allowed values: `NONE`, `INFO`, `WARNING`, `SUCCESS`, `ERROR`

### IAppInstallationRef

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

### AppSessionMessage

A status message displayed to the user within an app session. Messages convey progress, warnings, results, or errors from a running Benchling App. Each message has a textual content body and a visual style. Message content may contain inline chip references to Benchling objects using the `{id:<api_id>}` syntax.

- `__typename` (string, optional)
- `content` (string, optional) — The text body of the message, which may contain chip references like `{id:ent_abc123}`.
- `style` (enum, optional) — The visual style applied to this message.
  - Allowed values: `NONE`, `INFO`, `WARNING`, `SUCCESS`, `ERROR`

## Examples

**Request**

```json
{
  "items": [
    {
      "id": "id"
    }
  ]
}
```

**Response**

```json
{
  "items": [
    {
      "__typename": "__typename",
      "createdAt": "createdAt",
      "id": "id",
      "messages": [
        {}
      ],
      "modifiedAt": "modifiedAt",
      "name": "name",
      "status": "RUNNING",
      "timeoutSeconds": 1
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://{tenant_name}.benchling.com/api/v3/app-session:batch-update"

payload = { "items": [{ "id": "id" }] }
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/app-session:batch-update';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"items":[{"id":"id"}]}'
};

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