Skip to navigation
Benchling APILibrary Parameter Definition

Create LibraryParameterDefinition

Beta

Create a new library parameter definition in the Parameter Library.

Required fields

FieldDescription
nameDisplay name (1-44 characters, must contain at least one alphanumeric character)
descriptionWhat this parameter measures or represents (max 2048 characters)
dataTypeOne of FLOAT, DATETIME, TEXT, or DROPDOWN

Conditionally required fields

  • unitTypeId — Required when dataType is FLOAT. Must be omitted or null otherwise. Obtain a valid ID from GET /benchling/unit-type/items.
  • schemaFieldSelectorId — Required when dataType is DROPDOWN. Must be omitted or null otherwise. Obtain a valid ID from GET /benchling/dropdown/items.

Notes

  • The creator is automatically set to the authenticated user or app. The deprecated creatorId field is ignored.
  • dataType and unitTypeId are immutable after creation.
  • There is a per-tenant limit on the total number of library parameter definitions.

Authentication

AuthorizationBearer

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

Headers

EARLY-ACCESSstringOptional

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

Request

This endpoint expects an object.
dataTypeenumRequired

The data type of values recorded for this parameter. Determines which additional fields are required: FLOAT requires unitTypeId, DROPDOWN requires schemaFieldSelectorId. Cannot be changed after creation.

Allowed values:
descriptionstringRequired
A description of what this parameter measures or represents. Maximum 2048 characters.
namestringRequired
Display name for the parameter definition. Must contain at least one alphanumeric character. Maximum 44 characters.
unitTypeIdstring or nullOptional

The ID of the unit type for this parameter. Required when dataType is FLOAT, forbidden otherwise. Use GET /benchling/unit-type/items to list available unit types. Format: qnty_XXXXXXXX.

creatorIdstringOptionalDeprecated

Deprecated. This field is ignored — the creator is always set to the authenticated user.

Response

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

Errors

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