---
title: "Update an entity"
method: PATCH
path: "/entity-collections/{entity_collection_id}/entities/{entity_id}"
tags: ["entityCollections > entities"]
---

# Update an entity

`PATCH /entity-collections/{entity_collection_id}/entities/{entity_id}`

This method updates the specified entity within an entity collection. This operation allows modification of the entity's name, description, or metadata. Note that this endpoint does not affect the assets associated with the entity.

## Path parameters

- `entity_collection_id` string, required
- `entity_id` string, required

## Headers

- `x-api-key` string, required

## Request body

- object
  - `name` string — The new name for the entity.
  - `description` string — An updated description for the entity.
  - `metadata` EntityCollectionsEntityCollectionIdEntitiesEntityIdPatchRequestBodyContentApplicationJsonSchemaMetadata — Updated metadata for the entity. If provided, this completely replaces the existing metadata. Use this to store custom key-value pairs related to the entity.

## Response `200`

The entity has been successfully updated.

- Entity — An object that represents an entity with associated assets.
  - `_id` string — The unique identifier of the entity.
  - `entity_collection_id` string — The unique identifier of the entity collection this entity belongs to.
  - `name` string — The name of the entity.
  - `description` string — A description of the entity.
  - `metadata` EntityMetadata — Custom metadata for the entity.
  - `asset_ids` string[] — An array of asset IDs associated with the entity.
  - `status` 'processing' | 'ready' — The current status of the entity creation process. **Values**: - `processing`: The entity is being processed and is not yet ready for use in searches. - `ready`: The entity is fully processed and can be used in search queries.
  - `created_at` string, date-time — The date and time, in RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), when the entity was created.
  - `updated_at` string, date-time — The date and time, in RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), when the entity was last updated.

## Other responses

- `400` — The request has failed.

---

[API](https://skmtc.net/twelvelabs/apis/twelvelabs-api.md) · [All operations](https://skmtc.net/twelvelabs/apis/twelvelabs-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/twelvelabs/twelvelabs-api/versions/5dbd6e8473c9/schema)