Skip to navigation
Benchling APIBox Schema

Create BoxSchema

Beta
Create BoxSchema.

Authentication

AuthorizationBearer

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

Headers

EARLY-ACCESSstringOptional

Set to true to access beta operations via /api/v3.

Request

This endpoint expects an object.
descriptionstringRequired

A human-readable description of the schema. At most 1000 characters.

heightintegerRequired
The number of rows in the grid layout.
organizationIdstringRequired
The API ID of the organization this schema belongs to. The organization must exist and be accessible to the caller.
prefixstringRequired

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.

widthintegerRequired
The number of columns in the grid layout.
containerSchemaIdstringOptional
The API ID of the container schema constraining what types of containers can be stored in boxes of this type.
fieldDefinitionslist of objectsOptional
namestringOptional

The user-facing name of the schema. Must be non-empty after stripping whitespace, at most 255 characters, and unique within the organization.

systemNamestringOptional

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.

displayNamestringOptionalDeprecated
Deprecated. Use name instead.

Response

Created
__typenamestringOptional
archiveReasonstring or nullOptional
archivedbooleanOptional
containerSchemaobject or nullOptional
createdAtstring or nullOptional
descriptionstringOptional
A description of the schema.
fieldDefinitionsstringOptionalformat: "uri"
heightinteger or nullOptional
idstringOptional
modifiedAtstring or nullOptional
namestringOptional
prefixstring or nullOptional
registryobject or nullOptional
systemNamestringOptional
A unique, stable identifier for this schema used for programmatic access and integrations.
typestring or nullOptional
widthinteger or nullOptional

Errors

400
Box Schema Create Request Bad Request Error
403
Box Schema Create Request Forbidden Error
404
Box Schema Create Request Not Found Error
409
Box Schema Create Request Conflict Error
429
Box Schema Create Request Too Many Requests Error
500
Box Schema Create Request Internal Server Error