Skip to navigation
Benchling APIProtein

Update Protein

Update Protein.

Authentication

AuthorizationBearer

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

Path parameters

protein_idstringRequired
ID of the Protein.

Request

This endpoint expects an object.
aliaseslist of stringsOptional
Array of aliases
allowCustomFieldDeletionbooleanOptional
When true, custom fields present on the entity but omitted from the update payload will be deleted. When false or omitted, omitting existing custom fields is an error. Defaults to false.
archiveReasonstringOptional
archivedbooleanOptional
authorIdslist of stringsOptional
chainslist of objectsOptional

Replaces chain sequences when provided. Include one entry per chain label on the protein format; partial lists, unknown labels, and duplicate labels are rejected. Omit to leave chain sequences unchanged. If chains is provided, domains must also be provided.

customFieldsmap from strings to objectsOptional
Custom fields set on the protein.
domainslist of objectsOptional

Replaces domain sequences when provided. Include one entry per domain label on the protein format; incomplete required labels, unknown labels, and duplicate labels are rejected. Optional domains omitted from the list are removed from the protein, not left unchanged. When included, an optional label must be specified once and applies at every format position for that label. Omit domains to leave domain sequences unchanged. If domains is provided, chains must also be provided.

entityRegistryIdstringOptional

Registry ID to assign to the entity. When registering, specifying this value sets the registry ID of the entity. When already registered, specifying this value updates the entity’s registry ID. If set, naming_strategy must be unspecified.

folderIdstringOptional
namestringOptional
Name of the item.
namingStrategyenumOptional

Strategy to use for labeling the item in the registry if registering. If one is specified, the entity_registry_id must be unspecified.

registryIdstring or nullOptional
A not null value means the entity should be registered. A null value means it should be unregistered. If not null, the value must match the registry of the item's schema.
schemaFieldsmap from strings to objectsOptional

Values for schema-defined fields on this protein.

schemaIdstringOptional
studyIdslist of stringsOptional
Study IDs to add the protein to.

Response

OK
__typenamestringOptional
authorsstring or nullOptionalformat: "uri"
creatorobjectOptional
schemaFieldslist of objects or nullOptional

Values for schema-defined fields on this protein.

aliaseslist of strings or nullOptional
Array of aliases
archiveReasonstring or nullOptional
archivedbooleanOptional
chainslist of objectsOptional
The chains and associated amino acid sequences on the protein.
createdAtstringOptional
DateTime the protein was created.
customFieldslist of objects or nullOptional
Custom fields set on the protein.
domainslist of objectsOptional
The domains and associated amino acid sequences on the protein.
entityRegistryIdstring or nullOptional

The registry-assigned identifier for this item (e.g. its registry ID shown in the UI), present only once the item has been registered. Null if the item is not registered.

folderobject or nullOptional
formatobjectOptional

The protein format that defines the structure (domains, chains, interactions) for the protein.

fullHistorystringOptionalformat: "uri"

fullHistory is a superset of history that also returns inactive versions that are not part of the current version history. Versions are returned in chronological order (oldest first).

historystringOptionalformat: "uri"

Only the currently active version lineage, in chronological order (oldest first).

If a change was made and then undone by resetting to an earlier version, the version recording that change is not relevant to the current state of the entity, so it is not included in this listing.

idstringOptional
ID of the protein.
modifiedAtstringOptional
DateTime the protein was last modified.
namestringOptional
Name of the item.
outOfSyncbooleanOptional
Indicates if constituent domain or chain entities have changed since the protein was last updated.
outOfSyncReasonstring or nullOptional
Any additional information about why the protein is out of sync.
projectobject or nullOptional
registrationOriginobject or nullOptional

Provenance of this item’s registration — where and when it was registered. Null if unregistered.

registryobject or nullOptional
The Registry this item belongs to, if registered. Null if unregistered.
schemaobjectOptional

Use typedSchema instead, which returns the per-type schema.

typedSchemaobjectOptional
Schema reference for this protein. Callers can retrieve the schema separately when they need its field definitions.

Errors

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