--- title: "Update Location" method: PATCH path: "/api/v3/location/{location_id}" tags: ["Location"] --- # Update Location `PATCH /api/v3/location/{location_id}` ## Request - Base URL: `https://{tenant_name}.benchling.com` - URL: `https://{tenant_name}.benchling.com/api/v3/location/{location_id}` - Auth: HTTP bearer Update Location. ## Path parameters - `location_id` string, required ## Request body - UpdateLocationInput - `archiveReason` string: Why it is being archived. Required when `archived` is `true`, and not allowed when unarchiving. - `archived` boolean: Set to `true` to archive or `false` to unarchive it. Archiving requires `archiveReason`. - `barcode` string - `name` string - `parentStorageId` string, nullable - `schemaFields` object - `shouldRemoveBarcodes` boolean: Whether to remove the barcodes of the location and of every storable archived with it. Only allowed when archiving the location, and can't be combined with `barcode`. Locations can contain each other, so every location archived in one request must use the same value; an unset value counts as `false`. ## Response `200` OK - Location: A Location represents a physical storage area in Benchling's inventory system, such as a freezer, refrigerator, shelf, room, or building. Locations form a hierarchy where each location can contain child locations (e.g., a freezer contains shelves) as well as inventory items like Boxes, Plates, and Containers when allowNonLocationChildren is true. Each location tracks its capacity (totalCapacity, availableCapacity, occupiedCapacity) and can restrict what types of items it accepts via allowedInventorySchemas. Locations conform to a LocationSchema that defines custom fields for the location type. Locations are identified by barcode for physical tracking and can be archived when no longer in use. - `__typename` string - `allowNonLocationChildren` boolean: Whether this location can store plates, boxes, and containers. - `allowedInventorySchemas` ChildStorableSchema[]: The plate, box, and container schemas that can be stored in this location. If allowsNonLocationChildren is true and this list is empty, all schemas are allowed. - union: Non-location storables that can be a child of a location. - object: BoxSchema variant - `__typename` 'BoxSchema', required: Discriminator value: BoxSchema - `id` string, api_id - object: ContainerSchema variant - `__typename` 'ContainerSchema', required: Discriminator value: ContainerSchema - `id` string, api_id - object: MatrixPlateSchema variant - `__typename` 'MatrixPlateSchema', required: Discriminator value: MatrixPlateSchema - `id` string, api_id - object: WellPlateSchema variant - `__typename` 'WellPlateSchema', required: Discriminator value: WellPlateSchema - `id` string, api_id - `archiveReason` string, nullable - `archived` boolean - `availableCapacity` integer, nullable: The number of available positions in this location. Null if totalCapacity is not set. - `barcode` string, nullable - `createdAt` string, datetime, nullable - `id` string - `modifiedAt` string, datetime, nullable - `name` string, nullable - `occupiedCapacity` integer, nullable: The number of plates, boxes, and containers currently in this location. Null if totalCapacity is not set. - `parentStorage` LocationRef - `__typename` string - `id` string, api_id - `schema` LocationSchemaRef - `__typename` string - `id` string, api_id - `totalCapacity` integer, nullable: The total capacity of this location (i.e. how many plates, boxes, and containers it can store). If null, capacity is not limited. - `validationStatus` 'PASSED' | 'FAILED': Whether this location is passing all validation checks. - `creator` PrincipalRef - `__typename` string - `id` string, api_id - `schemaFields` SchemaFieldValue[], nullable - `__typename` string - `fieldDefinition` SchemaFieldDefinitionRef - `__typename` string - `id` string, api_id - `id` string - `linkedEntityId` string, nullable - `value` union: Types of values that Benchling can interpret. - object: A type that represents a list of BenchlingValues, used for multi-value cells (e.g. alias columns). - `__typename` 'ArrayValue', required: Discriminator value: ArrayValue - `value` SingularBenchlingValue[] - union: A union of value types that can appear as elements within an ArrayValue. Identical to BenchlingValue but excludes ArrayValue to prevent nesting. Keep in sync with BenchlingValue. - object: A type that represents boolean values. - … - object: A type that represents datetime values. - … - object: A type that represents date values. - … - object: A type that represents decimal value as strings. - … - object: A type that represents integer values. - … - object: A type that represents JSON values. - … - object: A type that represents a list of links to other objects. - … - object: A type that represents links to other objects. - … - object: A type that represents text (string) values with an associated URL. - … - object: A type that represents text (string) values. - … - object: A type that represents boolean values. - `__typename` 'BooleanValue', required: Discriminator value: BooleanValue - `value` boolean: The boolean value. - object: A type that represents datetime values. - `__typename` 'DateTimeValue', required: Discriminator value: DateTimeValue - `value` string, datetime: The datetime value with UTC as the timezone. - object: A type that represents date values. - `__typename` 'DateValue', required: Discriminator value: DateValue - `value` string, date: The date value. - object: A type that represents decimal value as strings. - `__typename` 'DecimalValue', required: Discriminator value: DecimalValue - `numericValue` number, double, nullable: Deprecated. The float representation of the decimal value. - `value` string, nullable: The decimal value in a string representation - object: A type that represents integer values. - `__typename` 'IntegerValue', required: Discriminator value: IntegerValue - `value` integer: The integer value. - object: A type that represents JSON values. - `__typename` 'JsonValue', required: Discriminator value: JsonValue - `value` union: The JSON value. - object - string[] - string - number, double - boolean - object: A type that represents a list of links to other objects. - `__typename` 'ObjectLinkListValue', required: Discriminator value: ObjectLinkListValue - `value` LinkableDomainObject[]: The list of objects that this value links to. Inaccessible objects may be returned instead if the object is not found with the current permission set. - union: A union representing items that can be linked to. If you have a type that can be linked to, it can only be added once it's in beta. - object: AaSequence variant - … - object: Attachment variant - … - object: Box variant - … - object: Container variant - … - object: CustomEntity variant - … - object: DnaOligo variant - … - object: DnaSequence variant - … - object: DropdownOption variant - … - object: Entry variant - … - object: Inaccessible variant - … - object: Location variant - … - object: MatrixPlate variant - … - object: Mixture variant - … - object: Molecule variant - … - object: OligoConjugate variant - … - object: OligoDuplex variant - … - object: Protein variant - … - object: Result variant - … - object: RnaOligo variant - … - object: RnaSequence variant - … - object: Run variant - … - object: WellPlate variant - … - object: A type that represents links to other objects. - `__typename` 'ObjectLinkValue', required: Discriminator value: ObjectLinkValue - `value` union: A union representing items that can be linked to. If you have a type that can be linked to, it can only be added once it's in beta. - object: AaSequence variant - `__typename` 'AaSequence', required: Discriminator value: AaSequence - `id` string, api_id - object: Attachment variant - `__typename` 'Attachment', required: Discriminator value: Attachment - `id` string, api_id - object: Box variant - `__typename` 'Box', required: Discriminator value: Box - `id` string, api_id - object: Container variant - `__typename` 'Container', required: Discriminator value: Container - `id` string, api_id - object: CustomEntity variant - `__typename` 'CustomEntity', required: Discriminator value: CustomEntity - `id` string, api_id - object: DnaOligo variant - `__typename` 'DnaOligo', required: Discriminator value: DnaOligo - `id` string, api_id - object: DnaSequence variant - `__typename` 'DnaSequence', required: Discriminator value: DnaSequence - `id` string, api_id - object: DropdownOption variant - `__typename` 'DropdownOption', required: Discriminator value: DropdownOption - `id` string, api_id - object: Entry variant - `__typename` 'Entry', required: Discriminator value: Entry - `id` string, api_id - object: Inaccessible variant - `__typename` 'Inaccessible', required: Discriminator value: Inaccessible - `id` string, api_id - object: Location variant - `__typename` 'Location', required: Discriminator value: Location - `id` string, api_id - object: MatrixPlate variant - `__typename` 'MatrixPlate', required: Discriminator value: MatrixPlate - `id` string, api_id - object: Mixture variant - `__typename` 'Mixture', required: Discriminator value: Mixture - `id` string, api_id - object: Molecule variant - `__typename` 'Molecule', required: Discriminator value: Molecule - `id` string, api_id - object: OligoConjugate variant - `__typename` 'OligoConjugate', required: Discriminator value: OligoConjugate - `id` string, api_id - object: OligoDuplex variant - `__typename` 'OligoDuplex', required: Discriminator value: OligoDuplex - `id` string, api_id - object: Protein variant - `__typename` 'Protein', required: Discriminator value: Protein - `id` string, api_id - object: Result variant - `__typename` 'Result', required: Discriminator value: Result - `id` string, api_id - object: RnaOligo variant - `__typename` 'RnaOligo', required: Discriminator value: RnaOligo - `id` string, api_id - object: RnaSequence variant - `__typename` 'RnaSequence', required: Discriminator value: RnaSequence - `id` string, api_id - object: Run variant - `__typename` 'Run', required: Discriminator value: Run - `id` string, api_id - object: WellPlate variant - `__typename` 'WellPlate', required: Discriminator value: WellPlate - `id` string, api_id - object: A type that represents text (string) values with an associated URL. - `__typename` string, required - `url` string: The URL associated with the value. Please use `TextValue` if you don't want a URL. - `value` string: The text value. It may or may not be an empty string. - object: A type that represents text (string) values. - `__typename` string, required - `value` string: The text value. It may or may not be an empty string. ## Other responses - `400`: Bad Request - `403`: Forbidden - `404`: Not Found - `409`: Conflict - `429`: Too Many Requests - `500`: Internal Server Error ## Changes - **2026-11-05** `c9f087b98b8b`: 1 info - added the new optional request property `shouldRemoveBarcodes` [Operation history](https://skmtc.dev/benchling/apis/benchling-api/changes/api/v3/location/:location_id/patch.md) --- [API](https://skmtc.dev/benchling/apis/benchling-api.md) - [All operations](https://skmtc.dev/benchling/apis/benchling-api/llms.txt) - [OpenAPI document](https://skmtc.dev/benchling/apis/benchling-api/revisions/c9f087b98b8b?raw)