BEbenchling
Protein Format

Update ProteinFormat

Update ProteinFormat.

patch/api/v3/protein-format/{protein_format_id}

Request

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

Path parameters

protein_format_idstring required

ID of the ProteinFormat.

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.

namestring

Updated display name of the protein format. When provided, the name must be non-empty after stripping whitespace, at most 255 characters, and unique among all protein format names in the organization (including built-in format names). Built-in protein formats cannot be renamed.

Response

OK

__typenamestring
archiveReasonstring nullable
archivedboolean
builtInboolean

Whether this is an out-of-the-box Benchling-provided format. These formats come pre-loaded and cannot be modified or deleted by users.

createdAtstring datetime

When the protein format was created.

idstring

API identifier of the protein format. Custom formats use the abfmt_ prefix; built-in formats use builtinabfmt_.

modifiedAtstring datetime

When the protein format was last modified.

namestring

The display name of the protein format.

originalVeritasstring nullable

The VERITAS string used to create the format.

Changes

No recorded changes to this operation across all 2 revisions of this API.