BEbenchling
Salt

Update Salt

Update a salt's name or code, or archive/unarchive it via the archived field. The salt structure is immutable and cannot be changed after creation. A new name must be unique (case-insensitive) across the Salt & Solvate library, and a salt cannot be unarchived while an active entry has the same name or structure.

patch/api/v3/salt/{salt_id}

Request

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

Path parameters

salt_idstring required

ID of the Salt.

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.

codestring nullable

Configurable identifier for this salt. Must be unique (case-insensitive) across the Salt & Solvate library.

namestring

The name of the salt. Must be unique (case-insensitive) across the Salt & Solvate library.

Response

OK

__typenamestring
archiveReasonstring nullable
archivedboolean
calculatedMolecularWeightnumber double nullable

The molecular weight of the salt.

canonicalSmilesstring

The SMILES representation of the salt after standardization.

codestring nullable

Optional configurable identifier for this salt (e.g., "HCl", "MS"). Unique across both salts and solvents within a tenant.

createdAtstring datetime
idstring
modifiedAtstring datetime
molecularFormulastring

The molecular formula (e.g., "HCl").

molfilestring

The molfile representation of the salt.

namestring

Changes

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