BEbenchling
Well Plate

Update WellPlate

Update WellPlate.

patch/api/v3/well-plate/{well_plate_id}

Request

  • Base URL
    https://{tenant_name}.benchling.com
  • Auth
    HTTP bearer

Path parameters

well_plate_idstring required

ID of the WellPlate.

Headers

EARLY-ACCESSstring

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

Request body

archiveReasonstring

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

archivedboolean

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

barcodestring

Barcode of the plate

namestring

Name of the plate; defaults to barcode if name is not provided

parentStorageIdstring nullable
projectIdstring nullable
schemaFieldsobject

Schema field values that belong to the plate

shouldRemoveBarcodesboolean

Whether to remove the barcodes of the plate and of every well archived with it. Only allowed when archiving the plate, and can't be combined with barcode.

Response

OK

__typenamestring
archiveReasonstring nullable

Why the plate is archived

archivedboolean

Whether the plate is archived

barcodestring nullable

Barcode of the plate

createdAtstring datetime

DateTime the plate was created

idstring

ID of the plate

modifiedAtstring datetime

DateTime the plate was last modified

namestring

Name of the plate; defaults to barcode if name is not provided

positionsstring uri

The wells of the plate

Changes

No recorded changes to this operation across all 2 revisions of this API.