Skip to navigation

Update WellPlateSchema

Beta
Update WellPlateSchema.

Authentication

AuthorizationBearer

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

Path parameters

well_plate_schema_idstringRequired
ID of the WellPlateSchema.

Headers

EARLY-ACCESSstringOptional

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

Request

This endpoint expects an object.
archiveReasonstringOptional

Why it is being archived. Required when archived is true, and not allowed when unarchiving.

archivedbooleanOptional

Set to true to archive or false to unarchive it. Archiving requires archiveReason.

containerSchemaIdstringOptional

The API ID of the container schema that defines the wells of plates of this schema. Must belong to the same organization as this schema and must not be archived. The container schema can have at most 10 required fields if the tenant allows required fields on well container schemas, and none otherwise. Omit to keep the current well schema; it cannot be removed. Changing it fails if existing plates of this schema have wells of a different container schema.

descriptionstringOptional
Updated description. When provided, must be at most 1000 characters.
heightintegerOptional

The number of rows of wells. Each dimension must be from 1 to 50, and height x width must match a predefined plate format (2x3, 3x4, 4x6, 6x8, 8x12 or 16x24) or a custom plate size configured for the tenant. Cannot change while the schema is in use, such as by existing plates (including archived ones) or by link fields on other schemas that target it.

namestringOptional

Updated user-facing name. When provided, must be non-empty after stripping whitespace, at most 255 characters, and unique within the organization.

prefixstringOptional

The prefix for barcodes auto-generated for inventory items of this schema. At most 32 characters of letters, digits, ’.’, ’_’ and ’-’, and cannot end in a digit. Must be unique among the box, container, location and plate schemas in the registry; the comparison is case-insensitive when the tenant has case-insensitive registry matching enabled.

reasonForChangeobjectOptional

Reason for change applied to the entire request. Only relevant to tenants with Data Modifications enabled, where it may be required to update or delete items and is validated against the tenant’s configured reasons. Tenants without Data Modifications enabled can omit it; if supplied, it is not validated.

systemNamestringOptional

Updated SQL identifier for the warehouse table name. When provided, 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. Changing it requires warehouse table-name changes to be enabled for the caller; otherwise the update fails with a validation error. Supplying the schema’s exact current system name always succeeds.

widthintegerOptional

The number of columns of wells. Each dimension must be from 1 to 50, and height x width must match a predefined plate format (2x3, 3x4, 4x6, 6x8, 8x12 or 16x24) or a custom plate size configured for the tenant. Cannot change while the schema is in use, such as by existing plates (including archived ones) or by link fields on other schemas that target it.

displayNamestringOptionalDeprecated
Deprecated. Use name instead.

Response

OK
__typenamestringOptional
archiveReasonstring or nullOptional
Why the schema was archived.
archivedbooleanOptional
Whether the schema is archived.
containerSchemaobjectOptional
The container schema used for positions in plates of this schema.
createdAtstringOptionalformat: "datetime"
When the schema was created.
descriptionstringOptional
A description of the schema.
fieldDefinitionsstringOptionalformat: "uri"
The fields inherited by plates of this schema.
heightintegerOptional
The number of rows in plates of this schema.
idstringOptional
The ID of the schema.
modifiedAtstringOptionalformat: "datetime"
When the schema was last modified.
namestringOptional
The name of the schema.
prefixstringOptional
The prefix of barcodes autogenerated for plates of this schema.
registryobjectOptional
The schema's registry.
systemNamestringOptional
A unique, stable identifier for this schema used for programmatic access and integrations.
widthintegerOptional
The number of columns in plates of this schema.

Errors

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