> 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 create BoxSchema

POST https://{tenant_name}.benchling.com/api/v3/box-schema:batch-create
Content-Type: application/json

Batch create BoxSchema synchronously in one transaction. Maximum 25 items per request.

Reference: https://docs.benchling.com/docs/api/benchling-api/box-schema/batchcreate

## 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 CreateBoxSchemaInput, required)

## Response

### 201

Created

- `items` (list of BoxSchema, required)

## Errors

### 400 Box Schema Batch Create 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 Box Schema Batch Create 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 Box Schema Batch Create 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 Box Schema Batch Create 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 Box Schema Batch Create 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 Box Schema Batch Create 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

### CreateBoxSchemaInput

- `description` (string, required) — A human-readable description of the schema. At most 1000 characters.
- `height` (integer, required) — The number of rows in the grid layout.
- `organizationId` (string, required) — The API ID of the organization this schema belongs to. The organization must exist and be accessible to the caller.
- `prefix` (string, required) — The prefix used for auto-generating barcodes for inventory items of this schema. Must be unique within the registry and cannot end in a digit.
- `width` (integer, required) — The number of columns in the grid layout.
- `containerSchemaId` (string, optional) — The API ID of the container schema constraining what types of containers can be stored in boxes of this type.
- `fieldDefinitions` (list of CreateBoxSchemaInputFieldDefinitionsItem, optional)
- `name` (string, optional) — The user-facing name of the schema. Must be non-empty after stripping whitespace, at most 255 characters, and unique within the organization.
- `systemName` (string, optional) — The SQL identifier used as the warehouse table name. If not provided, one is auto-generated from the display name. Must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name, cannot start with 'bnch$', and must be unique within the organization.
- `displayName` (string, optional, deprecated) — Deprecated. Use name instead.

### BoxSchema

Defines the structure and constraints for a category of Boxes in Benchling's inventory system. A BoxSchema specifies the grid dimensions (height and width) determining how many container positions the box has, and optionally links to a ContainerSchema that constrains what type of containers can be stored in boxes of this type. BoxSchemas support custom field definitions for capturing additional metadata about boxes. Each BoxSchema can be associated with a Registry and given a prefix for generating display IDs. Examples include "96-Well Freezer Box" or "81-Position Cryo Box".

- `__typename` (string, optional)
- `archiveReason` (string, optional, nullable)
- `archived` (boolean, optional)
- `containerSchema` (ContainerSchemaRef, optional, nullable)
- `createdAt` (string, optional, nullable)
- `description` (string, optional) — A description of the schema.
- `fieldDefinitions` (string, optional)
- `height` (integer, optional, nullable)
- `id` (string, optional)
- `modifiedAt` (string, optional, nullable)
- `name` (string, optional)
- `prefix` (string, optional, nullable)
- `registry` (RegistryRef, optional, nullable)
- `systemName` (string, optional) — A unique, stable identifier for this schema used for programmatic access and integrations.
- `type` (string, optional, nullable)
- `width` (integer, optional, nullable)

### GeneralErrorDetail

### TooManyRequestsErrorBodyDetail

### InternalServerErrorBodyDetail

### CreateBoxSchemaInputFieldDefinitionsItem

- `type`: `BOOLEAN`
  - `isRequired` (boolean, required) — When true, a value must be provided for this field.
  - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema.
  - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema.
  - `description` (string, optional) — An optional user-provided description of this field definition.
- `type`: `DATE`
  - `isRequired` (boolean, required) — When true, a value must be provided for this field.
  - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema.
  - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema.
  - `description` (string, optional) — An optional user-provided description of this field definition.
- `type`: `DATE_TIME`
  - `isRequired` (boolean, required) — When true, a value must be provided for this field.
  - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema.
  - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema.
  - `description` (string, optional) — An optional user-provided description of this field definition.
- `type`: `DECIMAL`
  - `isRequired` (boolean, required) — When true, a value must be provided for this field.
  - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema.
  - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema.
  - `description` (string, optional) — An optional user-provided description of this field definition.
  - `displayPrecision` (integer, optional) — The number of decimal places to display (0 to 10).
  - `numericMax` (double, optional) — The maximum allowed value, inclusive.
  - `numericMin` (double, optional) — The minimum allowed value, inclusive.
  - `unitId` (string, optional) — The API ID of the unit to associate with this field.
- `type`: `INTEGER`
  - `isRequired` (boolean, required) — When true, a value must be provided for this field.
  - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema.
  - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema.
  - `description` (string, optional) — An optional user-provided description of this field definition.
  - `numericMax` (double, optional) — The maximum allowed value, inclusive.
  - `numericMin` (double, optional) — The minimum allowed value, inclusive.
  - `unitId` (string, optional) — The API ID of the unit to associate with this field.
- `type`: `LONG_TEXT`
  - `isRequired` (boolean, required) — When true, a value must be provided for this field.
  - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema.
  - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema.
  - `description` (string, optional) — An optional user-provided description of this field definition.
- `type`: `TEXT`
  - `isRequired` (boolean, required) — When true, a value must be provided for this field.
  - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema.
  - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema.
  - `description` (string, optional) — An optional user-provided description of this field definition.
- `type`: `AA_SEQUENCE_LINK`
  - `isMulti` (boolean, required) — When true, multiple linked values are allowed.
  - `isRequired` (boolean, required) — When true, a value must be provided for this field.
  - `linkDefinitionId` (string, required, nullable) — The API ID of the schema to constrain links to, or null to allow links to any AA sequence.
  - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema.
  - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema.
  - `description` (string, optional) — An optional user-provided description of this field definition.
  - `isParent` (boolean, optional) — When true, indicates a parent-child relationship used in the registry's lot-numbering functionality.
- `type`: `ATTACHMENT_LINK`
  - `isMulti` (boolean, required) — When true, multiple linked values are allowed.
  - `isRequired` (boolean, required) — When true, a value must be provided for this field.
  - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema.
  - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema.
  - `description` (string, optional) — An optional user-provided description of this field definition.
- `type`: `CUSTOM_ENTITY_LINK`
  - `isMulti` (boolean, required) — When true, multiple linked values are allowed.
  - `isRequired` (boolean, required) — When true, a value must be provided for this field.
  - `linkDefinitionId` (string, required, nullable) — The API ID of the schema to constrain links to, or null to allow links to any custom entity.
  - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema.
  - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema.
  - `description` (string, optional) — An optional user-provided description of this field definition.
  - `isParent` (boolean, optional) — When true, indicates a parent-child relationship used in the registry's lot-numbering functionality.
- `type`: `DNA_OLIGO_LINK`
  - `isMulti` (boolean, required) — When true, multiple linked values are allowed.
  - `isRequired` (boolean, required) — When true, a value must be provided for this field.
  - `linkDefinitionId` (string, required) — The API ID of the schema/interface that linked items must belong to.
  - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema.
  - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema.
  - `description` (string, optional) — An optional user-provided description of this field definition.
  - `isParent` (boolean, optional) — When true, indicates a parent-child relationship used in the registry's lot-numbering functionality.
- `type`: `DNA_SEQUENCE_LINK`
  - `isMulti` (boolean, required) — When true, multiple linked values are allowed.
  - `isRequired` (boolean, required) — When true, a value must be provided for this field.
  - `linkDefinitionId` (string, required, nullable) — The API ID of the schema to constrain links to, or null to allow links to any DNA sequence.
  - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema.
  - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema.
  - `description` (string, optional) — An optional user-provided description of this field definition.
  - `isParent` (boolean, optional) — When true, indicates a parent-child relationship used in the registry's lot-numbering functionality.
- `type`: `DROPDOWN`
  - `dropdownId` (string, required) — The API ID of the Dropdown that defines the available options.
  - `isMulti` (boolean, required) — When true, multiple linked values are allowed.
  - `isRequired` (boolean, required) — When true, a value must be provided for this field.
  - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema.
  - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema.
  - `description` (string, optional) — An optional user-provided description of this field definition.
- `type`: `ENTITY_LINK`
  - `isMulti` (boolean, required) — When true, multiple linked values are allowed.
  - `isRequired` (boolean, required) — When true, a value must be provided for this field.
  - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema.
  - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema.
  - `description` (string, optional) — An optional user-provided description of this field definition.
- `type`: `ENTRY_LINK`
  - `isMulti` (boolean, required) — When true, multiple linked values are allowed.
  - `isRequired` (boolean, required) — When true, a value must be provided for this field.
  - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema.
  - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema.
  - `description` (string, optional) — An optional user-provided description of this field definition.
- `type`: `EQUIPMENT_LINK`
  - `isMulti` (boolean, required) — When true, multiple linked values are allowed.
  - `isRequired` (boolean, required) — When true, a value must be provided for this field.
  - `linkDefinitionId` (string, required, nullable) — The API ID of the schema to constrain links to, or null to allow links to any equipment.
  - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema.
  - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema.
  - `description` (string, optional) — An optional user-provided description of this field definition.
  - `isParent` (boolean, optional) — When true, indicates a parent-child relationship used in the registry's lot-numbering functionality.
- `type`: `MIXTURE_LINK`
  - `isMulti` (boolean, required) — When true, multiple linked values are allowed.
  - `isRequired` (boolean, required) — When true, a value must be provided for this field.
  - `linkDefinitionId` (string, required, nullable) — The API ID of the schema to constrain links to, or null to allow links to any mixture.
  - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema.
  - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema.
  - `description` (string, optional) — An optional user-provided description of this field definition.
  - `isParent` (boolean, optional) — When true, indicates a parent-child relationship used in the registry's lot-numbering functionality.
- `type`: `MOLECULE_LINK`
  - `isMulti` (boolean, required) — When true, multiple linked values are allowed.
  - `isRequired` (boolean, required) — When true, a value must be provided for this field.
  - `linkDefinitionId` (string, required, nullable) — The API ID of the schema to constrain links to, or null to allow links to any molecule.
  - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema.
  - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema.
  - `description` (string, optional) — An optional user-provided description of this field definition.
  - `isParent` (boolean, optional) — When true, indicates a parent-child relationship used in the registry's lot-numbering functionality.
- `type`: `OLIGO_CONJUGATE_LINK`
  - `isMulti` (boolean, required) — When true, multiple linked values are allowed.
  - `isRequired` (boolean, required) — When true, a value must be provided for this field.
  - `linkDefinitionId` (string, required, nullable) — The API ID of the schema to constrain links to, or null to allow links to any oligo conjugate.
  - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema.
  - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema.
  - `description` (string, optional) — An optional user-provided description of this field definition.
  - `isParent` (boolean, optional) — When true, indicates a parent-child relationship used in the registry's lot-numbering functionality.
- `type`: `OLIGO_DUPLEX_LINK`
  - `isMulti` (boolean, required) — When true, multiple linked values are allowed.
  - `isRequired` (boolean, required) — When true, a value must be provided for this field.
  - `linkDefinitionId` (string, required, nullable) — The API ID of the schema to constrain links to, or null to allow links to any oligo duplex.
  - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema.
  - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema.
  - `description` (string, optional) — An optional user-provided description of this field definition.
  - `isParent` (boolean, optional) — When true, indicates a parent-child relationship used in the registry's lot-numbering functionality.
- `type`: `PROTEIN_LINK`
  - `isMulti` (boolean, required) — When true, multiple linked values are allowed.
  - `isRequired` (boolean, required) — When true, a value must be provided for this field.
  - `linkDefinitionId` (string, required, nullable) — The API ID of the schema to constrain links to, or null to allow links to any antibody.
  - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema.
  - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema.
  - `description` (string, optional) — An optional user-provided description of this field definition.
  - `isParent` (boolean, optional) — When true, indicates a parent-child relationship used in the registry's lot-numbering functionality.
- `type`: `RNA_SEQUENCE_LINK`
  - `isMulti` (boolean, required) — When true, multiple linked values are allowed.
  - `isRequired` (boolean, required) — When true, a value must be provided for this field.
  - `linkDefinitionId` (string, required) — The API ID of the schema/interface that linked items must belong to.
  - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema.
  - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema.
  - `description` (string, optional) — An optional user-provided description of this field definition.
  - `isParent` (boolean, optional) — When true, indicates a parent-child relationship used in the registry's lot-numbering functionality.
- `type`: `RNA_OLIGO_LINK`
  - `isMulti` (boolean, required) — When true, multiple linked values are allowed.
  - `isRequired` (boolean, required) — When true, a value must be provided for this field.
  - `linkDefinitionId` (string, required) — The API ID of the schema/interface that linked items must belong to.
  - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema.
  - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema.
  - `description` (string, optional) — An optional user-provided description of this field definition.
  - `isParent` (boolean, optional) — When true, indicates a parent-child relationship used in the registry's lot-numbering functionality.
- `type`: `STORAGE_LINK`
  - `isMulti` (boolean, required) — When true, multiple linked values are allowed.
  - `isRequired` (boolean, required) — When true, a value must be provided for this field.
  - `linkDefinitionId` (string, required, nullable) — The API ID of the schema to constrain links to, or null to allow links to any storage location.
  - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema.
  - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema.
  - `description` (string, optional) — An optional user-provided description of this field definition.

### ContainerSchemaRef

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

### RegistryRef

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

## Examples

**Request**

```json
{
  "items": [
    {
      "description": "description",
      "height": 1,
      "organizationId": "organizationId",
      "prefix": "prefix",
      "width": 1
    }
  ]
}
```

**Response**

```json
{
  "items": [
    {
      "__typename": "__typename",
      "archiveReason": "archiveReason",
      "archived": true,
      "createdAt": "createdAt",
      "description": "description",
      "fieldDefinitions": "fieldDefinitions",
      "height": 1,
      "id": "id",
      "modifiedAt": "modifiedAt",
      "name": "name",
      "prefix": "prefix",
      "systemName": "systemName",
      "type": "type",
      "width": 1
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://{tenant_name}.benchling.com/api/v3/box-schema:batch-create"

payload = { "items": [
        {
            "description": "description",
            "height": 1,
            "organizationId": "organizationId",
            "prefix": "prefix",
            "width": 1
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript
const url = 'https://{tenant_name}.benchling.com/api/v3/box-schema:batch-create';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"items":[{"description":"description","height":1,"organizationId":"organizationId","prefix":"prefix","width":1}]}'
};

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