Sign in

v3

latestOpenAPI 3.1.02026-07-3197486526.1 KB
entityCollections

Update an entity collection

This method updates the specified entity collection.

patch/entity-collections/{entity_collection_id}

Path parameters

entity_collection_idstring required

The unique identifier of the entity collection to update.

Headers

x-api-keystring required

Your API key.

<Note title="Note"> You can find your API key on the <a href="https://playground.twelvelabs.io/dashboard/api-keys" target="_blank">API Keys</a> page. </Note>

Request body

namestring

The updated name of the entity collection.

descriptionstring

The updated description of the entity collection.

Response

The entity collection has been successfully updated.

_idstring

The unique identifier of the entity collection.

namestring

The name of the entity collection.

descriptionstring

The description of the entity collection.

created_atstring date-time

The date and time, in RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), when the entity collection was created.

updated_atstring date-time

The date and time, in RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), when the entity collection was last updated.