Update Reaction

Beta

PATCH

https://{tenant_name}.benchling.com/api/v3/reaction/:reaction_id

PATCH

/api/v3/reaction/:reaction_id

curl -X PATCH https://{tenant_name}.benchling.com/api/v3/reaction/reaction_id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "archiveReason": "Made in error",
  "archived": true
}'

{
  "__typename": "__typename",
  "archiveReason": "archiveReason",
  "archived": true,
  "authors": "authors",
  "components": [
    {
      "__typename": "__typename",
      "amountActual": "amountActual",
      "amountPlan": "amountPlan",
      "calculationBase": "MOL_EQUIVALENT",
      "concentration": "concentration",
      "molActual": "molActual",
      "molEquivalent": "molEquivalent",
      "molPlan": "molPlan",
      "purity": "purity",
      "role": "REACTANT"
    }
  ],
  "createdAt": "createdAt",
  "creator": {
    "__typename": "__typename",
    "id": "id"
  },
  "entry": {
    "__typename": "__typename",
    "id": "id"
  },
  "folder": {
    "__typename": "__typename",
    "id": "id"
  },
  "id": "id",
  "modifiedAt": "modifiedAt",
  "name": "name",
  "webUrl": "webUrl"
}

Archive or unarchive a reaction.

Set archived to true (with an optional archiveReason) to archive a reaction, or false to unarchive it. Editing a submitted reaction’s name, components, or folder is not supported through the API.

Authentication

AuthorizationBearer

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

Path parameters

reaction_idstringRequired

ID of the Reaction.

Request

This endpoint expects an object.

archiveReasonstringOptional

archivedbooleanOptional

Response

__typenamestringOptional

archiveReasonstring or nullOptional

archivedbooleanOptional

authorsstring or nullOptionalformat: "uri"

componentslist of objectsOptional

createdAtstring or nullOptional

creatorobjectOptional

entryobject or nullOptional

folderobjectOptional

idstringOptional

modifiedAtstring or nullOptional

namestringOptional

webUrlstringOptional

Errors

400

Reaction Update Request Bad Request Error

403

Reaction Update Request Forbidden Error

404

Reaction Update Request Not Found Error

409

Reaction Update Request Conflict Error

429

Reaction Update Request Too Many Requests Error

500

Reaction Update Request Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors