BEbenchling
Reaction

Update Reaction

Archive or unarchive a reaction.

Set archived to true with archiveReason to archive a reaction, or false to unarchive it. Set studyIds to replace the studies the reaction is associated with. Editing a submitted reaction's name, components, or folder is not supported through the API.

patch/api/v3/reaction/{reaction_id}

Request

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

Path parameters

reaction_idstring required

ID of the Reaction.

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.

studyIdsstring[]

Study IDS to associate with the item.

Response

OK

__typenamestring
archiveReasonstring nullable
archivedboolean
authorsstring uri nullable
createdAtstring datetime nullable
idstring
modifiedAtstring datetime nullable
namestring
webUrlstring

Changes

No recorded changes to this operation across all 1 revision of this API.