---
title: "Batch update Reaction"
method: PATCH
path: "/api/v3/reaction:batch-update"
tags: ["Reaction"]
---

# Batch update Reaction

`PATCH /api/v3/reaction:batch-update`

## Request

- Base URL: `https://{tenant_name}.benchling.com`
- URL: `https://{tenant_name}.benchling.com/api/v3/reaction:batch-update`
- Auth: HTTP bearer

Batch archive or unarchive reactions synchronously in one transaction. Maximum 25 items per request.

When `archived` is `true`, `archiveReason` is required for each item.

## Headers

- `EARLY-ACCESS` string

## Request body

- object
  - `items` UpdateReactionInputWithPathParams[], required
    - `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`.
    - `id` string, required
    - `studyIds` string[]: Study IDS to associate with the item.

## Response `200`

OK

- ReactionBatchupdateResponse200
  - `items` Reaction[], required
    - `__typename` string
    - `archiveReason` string, nullable
    - `archived` boolean
    - `authors` string, uri, nullable
    - `components` ReactionComponentUnion[]
      - union: Union of StandardReactionComponent, ReactantComponent, ProductComponent
        - object: Reaction component sub-type for products
          - `__typename` 'ProductComponent', required: Discriminator value: ProductComponent
          - `amountActual` string, decimal, nullable
          - `amountPlan` string, decimal, nullable
          - `amountUnit` UnitRef
            - `__typename` string
            - `id` string, api_id
          - `amountYield` string, decimal, nullable
          - `calculationBase` 'MOL_EQUIVALENT' | 'MOL_PLAN' | 'AMOUNT_PLAN'
          - `concentration` string, decimal, nullable
          - `concentrationUnit` UnitRef
            - `__typename` string
            - `id` string, api_id
          - `linkedLot` CustomEntityRef
            - `__typename` string
            - `id` string, api_id
          - `linkedMolecule` union: Union of InternalLinkedMolecule, ExternalLinkedMolecule
            - object: Linked molecule from external registries/catalogs
              - …
            - object: Linked molecule from the Benchling registry (internal)
              - …
          - `molActual` string, decimal, nullable
          - `molEquivalent` string, decimal, nullable
          - `molPlan` string, decimal, nullable
          - `molUnit` UnitRef
            - `__typename` string
            - `id` string, api_id
          - `purity` string, decimal, nullable
          - `role` 'REACTANT' | 'PRODUCT' | 'REAGENT' | 'BYPRODUCT' | 'SOLVENT' | 'CATALYST'
        - object: Reaction component sub-type for reactants
          - `__typename` 'ReactantComponent', required: Discriminator value: ReactantComponent
          - `amountActual` string, decimal, nullable
          - `amountPlan` string, decimal, nullable
          - `amountUnit` UnitRef
            - `__typename` string
            - `id` string, api_id
          - `calculationBase` 'MOL_EQUIVALENT' | 'MOL_PLAN' | 'AMOUNT_PLAN'
          - `concentration` string, decimal, nullable
          - `concentrationUnit` UnitRef
            - `__typename` string
            - `id` string, api_id
          - `isLimitingReactant` boolean
          - `linkedLot` CustomEntityRef
            - `__typename` string
            - `id` string, api_id
          - `linkedMolecule` union: Union of InternalLinkedMolecule, ExternalLinkedMolecule
            - object: Linked molecule from external registries/catalogs
              - …
            - object: Linked molecule from the Benchling registry (internal)
              - …
          - `molActual` string, decimal, nullable
          - `molEquivalent` string, decimal, nullable
          - `molPlan` string, decimal, nullable
          - `molUnit` UnitRef
            - `__typename` string
            - `id` string, api_id
          - `purity` string, decimal, nullable
          - `role` 'REACTANT' | 'PRODUCT' | 'REAGENT' | 'BYPRODUCT' | 'SOLVENT' | 'CATALYST'
        - object: Generic type for most reaction components
          - `__typename` string, required
          - `amountActual` string, decimal, nullable
          - `amountPlan` string, decimal, nullable
          - `amountUnit` UnitRef
            - `__typename` string
            - `id` string, api_id
          - `calculationBase` 'MOL_EQUIVALENT' | 'MOL_PLAN' | 'AMOUNT_PLAN'
          - `concentration` string, decimal, nullable
          - `concentrationUnit` UnitRef
            - `__typename` string
            - `id` string, api_id
          - `linkedLot` CustomEntityRef
            - `__typename` string
            - `id` string, api_id
          - `linkedMolecule` union: Union of InternalLinkedMolecule, ExternalLinkedMolecule
            - object: Linked molecule from external registries/catalogs
              - …
            - object: Linked molecule from the Benchling registry (internal)
              - …
          - `molActual` string, decimal, nullable
          - `molEquivalent` string, decimal, nullable
          - `molPlan` string, decimal, nullable
          - `molUnit` UnitRef
            - `__typename` string
            - `id` string, api_id
          - `purity` string, decimal, nullable
          - `role` 'REACTANT' | 'PRODUCT' | 'REAGENT' | 'BYPRODUCT' | 'SOLVENT' | 'CATALYST'
    - `createdAt` string, datetime, nullable
    - `creator` PrincipalRef
      - `__typename` string
      - `id` string, api_id
    - `entry` EntryRef
      - `__typename` string
      - `id` string, api_id
    - `folder` FolderRef
      - `__typename` string
      - `id` string, api_id
    - `id` string
    - `modifiedAt` string, datetime, nullable
    - `name` string
    - `webUrl` string

## Other responses

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

---

[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)