Skip to navigation
Benchling APILibrary Parameter Definition

Update LibraryParameterDefinition

Beta

Update a library parameter definition.

Updatable fields

FieldDescription
nameDisplay name (1-44 characters, at least one alphanumeric character)
descriptionParameter description (max 2048 characters)

Archiving

To archive, set all three fields together:

  • archived: true
  • archiveReason: a non-empty string explaining why
  • archiveUserId: the ID of the user performing the archive (format: ent_XXXXXXXX)

To unarchive, set archived to false.

Immutable fields

The following fields are set at creation and cannot be changed via update:

  • dataType
  • unitTypeId

Authentication

AuthorizationBearer

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

Path parameters

library_parameter_definition_idstringRequired
ID of the LibraryParameterDefinition.

Headers

EARLY-ACCESSstringOptional

Set to true to access beta operations via /api/v3.

Request

This endpoint expects an object.
archiveReasonstringOptional
archivedbooleanOptional
descriptionstringOptional
Updated description. Maximum 2048 characters.
namestringOptional
Updated display name. Must contain at least one alphanumeric character. Maximum 44 characters.

Response

OK
__typenamestringOptional
archiveReasonstring or nullOptional
archivedbooleanOptional
createdAtstringOptional
creatorobjectOptional
dataTypeenumOptional
descriptionstringOptional
idstringOptional
modifiedAtstringOptional
namestringOptional
unitTypeobject or nullOptional

Errors

400
Library Parameter Definition Update Request Bad Request Error
403
Library Parameter Definition Update Request Forbidden Error
404
Library Parameter Definition Update Request Not Found Error
409
Library Parameter Definition Update Request Conflict Error
429
Library Parameter Definition Update Request Too Many Requests Error
500
Library Parameter Definition Update Request Internal Server Error