Update AaSequence

PATCH

https://{tenant_name}.benchling.com/api/v3/aa-sequence/:aa_sequence_id

PATCH

/api/v3/aa-sequence/:aa_sequence_id

curl -X PATCH https://{tenant_name}.benchling.com/api/v3/aa-sequence/aa_sequence_id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "annotations": [
    {
      "end": 10,
      "name": "N-terminal tag",
      "start": 0,
      "annotationId": "prtnann_abc123xy",
      "color": "#4ECDC4",
      "notes": "Updated tag region",
      "type": "Tag"
    },
    {
      "end": 18,
      "name": "Linker region",
      "start": 10,
      "color": "#45B7D1",
      "type": "Linker"
    }
  ],
  "name": "Example recombinant protein (v2)"
}'

{
  "__typename": "__typename",
  "authors": "authors",
  "creator": {
    "__typename": "__typename",
    "id": "id"
  },
  "schemaFields": [
    {
      "__typename": "__typename",
      "id": "id",
      "linkedEntityId": "linkedEntityId"
    }
  ],
  "aliases": [
    "aliases"
  ],
  "aminoAcids": "aminoAcids",
  "annotations": "annotations",
  "archiveReason": "archiveReason",
  "archived": true,
  "createdAt": "createdAt",
  "customFields": [
    {
      "__typename": "__typename",
      "name": "name",
      "value": "value"
    }
  ],
  "entityRegistryId": "entityRegistryId",
  "folder": {
    "__typename": "__typename",
    "id": "id"
  },
  "id": "id",
  "modifiedAt": "modifiedAt",
  "name": "name",
  "project": {
    "__typename": "__typename",
    "id": "id"
  },
  "registrationOrigin": {
    "__typename": "__typename",
    "originEntry": {
      "__typename": "__typename",
      "id": "id"
    },
    "registeredAt": "registeredAt"
  },
  "registry": {
    "__typename": "__typename",
    "id": "id"
  },
  "schema": {
    "__typename": "__typename",
    "id": "id"
  },
  "typedSchema": {
    "__typename": "__typename",
    "id": "id"
  }
}

Update an AA sequence.

Authentication

AuthorizationBearer

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

Path parameters

aa_sequence_idstringRequired

ID of the AaSequence.

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.

aminoAcidsstringOptional

Updates the amino acids of the AA sequence when provided. Letters A-Z only (case-insensitive). Invalid characters are rejected. There is a per-tenant limit on sequence length (50,000 characters by default). The request must also include an annotations property (use annotations: [] to clear annotations); that value replaces the sequence’s full annotation set.

annotationslist of objectsOptional

Replaces the sequence’s full annotation set when provided. Include annotationId on an entry to update an existing annotation; omit it to create a new one.

archiveReasonstringOptional

archivedbooleanOptional

authorIdslist of stringsOptional

customFieldsmap from strings to objectsOptional

Custom fields set on the AA sequence.

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

schemaIdstringOptional

Response

__typenamestringOptional

authorsstring or nullOptionalformat: "uri"

creatorobject or nullOptional

schemaFieldslist of objects or nullOptional

aliaseslist of strings or nullOptional

Array of aliases

aminoAcidsstringOptional

Amino acids of the AA sequence.

annotationsstringOptionalformat: "uri"

Annotations marking functional regions, domains, binding sites, post-translational modifications, or other features on the AA sequence.

archiveReasonstring or nullOptional

archivedbooleanOptional

createdAtstring or nullOptional

DateTime the AA sequence was created.

customFieldslist of objects or nullOptional

Custom fields set on the AA sequence.

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

Folder containing the AA sequence.

idstringOptional

ID of the AA sequence.

modifiedAtstring or nullOptional

DateTime the AA sequence was last modified.

namestringOptional

Name of the item.

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.

schemaobject or nullOptional

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

typedSchemaobject or nullOptional

Errors

400

Aa Sequence Update Request Bad Request Error

403

Aa Sequence Update Request Forbidden Error

404

Aa Sequence Update Request Not Found Error

409

Aa Sequence Update Request Conflict Error

429

Aa Sequence Update Request Too Many Requests Error

500

Aa Sequence Update Request Internal Server Error