Update Container

PATCH

https://{tenant_name}.benchling.com/api/v3/container/:container_id

PATCH

/api/v3/container/:container_id

curl -X PATCH https://{tenant_name}.benchling.com/api/v3/container/container_id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "__typename": "__typename",
  "creator": {
    "__typename": "__typename",
    "id": "id"
  },
  "schemaFields": [
    {
      "__typename": "__typename",
      "id": "id",
      "linkedEntityId": "linkedEntityId"
    }
  ],
  "archiveReason": "archiveReason",
  "archived": true,
  "barcode": "barcode",
  "checkoutRecord": {
    "__typename": "__typename",
    "assignee": {
      "__typename": "__typename",
      "id": "id"
    },
    "comment": "comment",
    "modifiedAt": "modifiedAt",
    "status": "AVAILABLE"
  },
  "contents": [
    {
      "__typename": "__typename",
      "createdAt": "createdAt",
      "modifiedAt": "modifiedAt"
    }
  ],
  "coordinates": {
    "__typename": "__typename",
    "column": 1,
    "index": 1,
    "position": "position",
    "row": 1
  },
  "createdAt": "createdAt",
  "expirationInfo": {
    "__typename": "__typename",
    "expirationDate": "expirationDate",
    "isExpired": true
  },
  "id": "id",
  "modifiedAt": "modifiedAt",
  "name": "name",
  "parentStorage": {
    "__typename": "__typename",
    "id": "id"
  },
  "parentStorageSchema": {
    "__typename": "__typename",
    "id": "id"
  },
  "project": {
    "__typename": "__typename",
    "id": "id"
  },
  "quantity": {
    "__typename": "__typename",
    "unit": {
      "__typename": "__typename",
      "id": "id"
    },
    "value": 1.1
  },
  "role": {
    "__typename": "__typename",
    "group": 1,
    "primaryRole": "CONTROL",
    "subrole": "subrole"
  },
  "schema": {
    "__typename": "__typename",
    "id": "id"
  }
}

Update Container.

Authentication

AuthorizationBearer

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

Path parameters

container_idstringRequired

ID of the Container.

Request

This endpoint expects an object.

archiveReasonstringOptional

archivedbooleanOptional

checkoutRecordobjectOptional

namestringOptional

parentStorageIdstring or nullOptional

projectIdstring or nullOptional

quantityobjectOptional

Quantity of a container, well, or transfer. Supports mass, volume, and other quantities.

restrictedSamplePartyIdslist of stringsOptional

API IDs of the restricted sample parties (a party is a Benchling user, Organization, or Team). Limited to 100 items.

restrictionStatusenumOptional

Allowed values:

roleobject or nullOptional

sampleOwnerIdslist of stringsOptional

API IDs of the sample owners (an owner is a Benchling user, Organization, or Team). Limited to 100 items.

schemaFieldsmap from strings to objectsOptional

Response

__typenamestringOptional

creatorobjectOptional

schemaFieldslist of objects or nullOptional

archiveReasonstring or nullOptional

archivedbooleanOptional

barcodestring or nullOptional

checkoutRecordobjectOptional

Tracks the checkout status of an inventory item such as a Container. When laboratory samples need to be temporarily removed from storage (e.g., for an experiment), users can check them out, optionally adding a comment and assigning responsibility to a user or team (see Assignee). The record captures when the status was last modified. This enables sample tracking workflows and prevents conflicts when multiple users need access to the same samples.

contentslist of objectsOptional

coordinatesobject or nullOptional

Coordinates of the container within its contained grid, if it is contained within a grid.

createdAtstringOptional

expirationInfoobjectOptional

Expiration info for the container.

idstringOptional

modifiedAtstringOptional

namestringOptional

parentStorageobject or nullOptional

Union of Box, WellPlate, MatrixPlate, Location

parentStorageSchemaobject or nullOptional

Union of BoxSchema, WellPlateSchema, MatrixPlateSchema, LocationSchema

projectobject or nullOptional

quantityobject or nullOptional

Quantity of a container, well, or transfer. Supports mass, volume, and other quantities.

roleobject or nullOptional

Represents the complete experimental designation of a well or container within an assay, combining a primary role (see PrimaryExperimentalRole), replicate group number, and optional subrole. The group field identifies replicate sets: wells with the same primary role and group number are treated as technical replicates for statistical analysis. The subrole field provides additional categorization for controls (e.g., POSITIVE, NEGATIVE, MAXIMUM, MINIMUM); only CONTROL primary roles may have subroles. ExperimentalRole is used in plate-based workflows to define experimental layouts (see PlateMapPosition) and annotate wells in FixedPlate and Container objects.

schemaobjectOptional

gridNumberdouble or nullOptionalDeprecated

Please use coordinates.index

gridPositionstring or nullOptionalDeprecated

Please use coordinates.position

Errors

400

Container Update Request Bad Request Error

403

Container Update Request Forbidden Error

404

Container Update Request Not Found Error

409

Container Update Request Conflict Error

429

Container Update Request Too Many Requests Error

500

Container Update Request Internal Server Error