---
title: "Update a custom entity"
method: PATCH
path: "/custom-entities/{custom_entity_id}"
tags: ["customEntities"]
---

# Update a custom entity

`PATCH /custom-entities/{custom_entity_id}`

## Request

- Base URL: `https://{tenant_name}.benchling.com/api/v2`
- URL: `https://{tenant_name}.benchling.com/api/v2/custom-entities/{custom_entity_id}`
- Auth: HTTP bearer

Update a custom entity

## Path parameters

- `custom_entity_id` string, required

## Request body

- CustomEntityUpdate
  - `aliases` string[]: Aliases to add to the custom entity
  - `authorIds` string[]: IDs of users to set as the custom entity's authors.
  - `customFields` CustomFields
  - `fields` Fields
  - `folderId` string: ID of the folder that the entity is moved into
  - `name` string
  - `schemaId` string
  - `entityRegistryId` string

## Response `200`

OK

- CustomEntity
  - `aliases` string[]
  - `apiURL` string, uri: The canonical url of the Custom Entity in the API.
  - `archiveRecord` ArchiveRecord
    - `reason` string
  - `authors` UserSummary[]
    - `handle` string
    - `id` string
    - `name` string
  - `createdAt` string, date-time
  - `creator` CustomEntityCreator
    - `handle` string
    - `id` string
    - `name` string
  - `customFields` CustomFields
  - `entityRegistryId` string, nullable
  - `fields` Fields
  - `folderId` string, nullable
  - `id` string
  - `modifiedAt` string, date-time
  - `name` string
  - `registrationOrigin` RegistrationOrigin
    - `originEntryId` string, nullable
    - `registeredAt` string, date-time
  - `registryId` string, nullable
  - `schema` SchemaSummary
    - `id` string
    - `name` string
  - `url` string: The path of the web URL, omitting the tenant domain
  - `webURL` string

## Other responses

- `400`: Bad Request

---

[API](https://skmtc.dev/benchling/apis/benchling-api-2.md) - [All operations](https://skmtc.dev/benchling/apis/benchling-api-2/llms.txt) - [OpenAPI document](https://skmtc.dev/benchling/apis/benchling-api-2/revisions/01d2fa8523cd?raw)