entityCollections

Update an entity collection

Changed on

This method updates the specified entity collection.

patch/entity-collections/{entity_collection_id}

Request

  • Base URL: https://api.twelvelabs.io/v1.3
  • URL: https://api.twelvelabs.io/v1.3/entity-collections/{entity_collection_id}
  • Auth: API key in header x-api-key

Path parameters

entity_collection_idstring required

The unique identifier of the entity collection to update.

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.

Changes