Update a custom entity

PATCH

https://{tenant_name}.benchling.com/api/v2/custom-entities/:custom_entity_id

PATCH

/api/v2/custom-entities/:custom_entity_id

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

{
  "aliases": [
    "sBN000"
  ],
  "apiURL": "https://benchling.com/api/v2/custom-entities/bfi_xCUXNVyG",
  "archiveRecord": {
    "reason": "Made in error"
  },
  "authors": [
    {
      "handle": "string",
      "id": "string",
      "name": "string"
    }
  ],
  "createdAt": "2017-04-18T05:54:56.247545+00:00",
  "creator": {
    "handle": "string",
    "id": "string",
    "name": "string"
  },
  "customFields": {
    "Legacy ID": {
      "value": "STR100"
    }
  },
  "entityRegistryId": "sBN000",
  "fields": {},
  "folderId": "lib_R8KcsjhW",
  "id": "bfi_xCUXNVyG",
  "modifiedAt": "2017-04-18T05:55:48.685345+00:00",
  "name": "sBN000",
  "registrationOrigin": {
    "originEntryId": "string",
    "registeredAt": "2024-01-15T09:30:00Z"
  },
  "registryId": "src_NetYd96a",
  "schema": {
    "id": "ts_EM122lfJ",
    "name": "Strain"
  },
  "url": "string",
  "webURL": "https://benchling.com/benchling/f/R8KcsjhW-academic-registry/bfi-xCUXNVyG-sbn000/edit"
}

Update a custom entity

Authentication

AuthorizationBearer

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

Path parameters

custom_entity_idstringRequired

Request

This endpoint expects an object.

aliaseslist of stringsOptional

Aliases to add to the custom entity

authorIdslist of stringsOptional

IDs of users to set as the custom entity's authors.

customFieldsmap from strings to objectsOptional

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

entityRegistryIdstringOptional

fieldsmap from strings to objectsOptional

Schema fields to set on the custom entity. 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 that the entity is moved into

namestringOptional

schemaIdstringOptional

Response

aliaseslist of stringsOptional

apiURLstringOptionalRead-onlyformat: "uri"

The canonical url of the Custom Entity in the API.

archiveRecordobject or nullOptional

authorslist of objectsOptional

createdAtdatetimeOptionalRead-only

creatorobjectOptional

customFieldsmap from strings to objectsOptional

entityRegistryIdstring or nullOptional

fieldsmap from strings to objectsOptional

folderIdstring or nullOptional

idstringOptional

modifiedAtdatetimeOptionalRead-only

namestringOptional

registrationOriginobject or nullOptional

registryIdstring or nullOptional

schemaobject or nullOptional

urlstringOptional

The path of the web URL, omitting the tenant domain

webURLstringOptionalRead-only

Errors

400

Bad Request Error