Update an Oligo

Deprecated

PATCH

https://{tenant_name}.benchling.com/api/v2/oligos/:oligo_id

PATCH

/api/v2/oligos/:oligo_id

curl -X PATCH https://{tenant_name}.benchling.com/api/v2/oligos/oligo_id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "aliases": [
    "string"
  ],
  "annotations": [
    {
      "color": "#F58A5E",
      "customFields": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "end": 1,
      "name": "string",
      "notes": "Cong et al Science. 2013 Jan 3.",
      "start": 1,
      "strand": 1,
      "type": "string"
    }
  ],
  "apiURL": "https://benchling.com/api/v2/dna-oligos/seq_bhuDUw9D",
  "archiveRecord": {
    "reason": "Made in error"
  },
  "authors": [
    {
      "handle": "string",
      "id": "string",
      "name": "string"
    }
  ],
  "bases": "ACTTTTT",
  "createdAt": "2024-01-15T09:30:00Z",
  "creator": {
    "handle": "string",
    "id": "string",
    "name": "string"
  },
  "customFields": {},
  "customNotation": "string",
  "customNotationName": "string",
  "entityRegistryId": "string",
  "fields": {},
  "folderId": "string",
  "helm": "RNA1{d(A)p.d(C)[Ssp].d(T)p.d(T)p.d(T)p.d(T)p.d(T)p}$$$$V2.0",
  "id": "seq_bhuDUw9D",
  "length": 1,
  "modifiedAt": "2024-01-15T09:30:00Z",
  "name": "string",
  "nucleotideType": "DNA",
  "registrationOrigin": {
    "originEntryId": "string",
    "registeredAt": "2024-01-15T09:30:00Z"
  },
  "registryId": "string",
  "schema": {
    "id": "string",
    "name": "string"
  },
  "webURL": "https://benchling.com/benchling/f/lib_hBHqKbzE-oligos/seq_bhuDUw9D-test-oligo-abc/edit"
}

Update an Oligo

Authentication

AuthorizationBearer

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

Path parameters

oligo_idstringRequired

Request

This endpoint expects an object.

aliaseslist of stringsOptional

Aliases to add to the Oligo

authorIdslist of stringsOptional

IDs of users to set as the Oligo's authors.

basesstringOptional

Base pairs of the oligo.

customFieldsmap from strings to objectsOptional

Custom fields to add to the Oligo. Every field should have its name as a key, mapping to an object with information about the value of the field.

fieldsmap from strings to objectsOptional

Fields to set on the Oligo. Must correspond with the schema's field definitions. Every field should have its name as a key, mapping to an object with information about the value of the field.

folderIdstringOptional

ID of the folder containing the Oligo.

namestringOptional

Name of the Oligo.

schemaIdstringOptional

ID of the oligo's schema.

Response

Errors

400

Bad Request Error