API ReferenceManage entities

Update an entity

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_idstringRequired
The unique identifier of the entity collection containing the entity to be updated.
entity_idstringRequired
The unique identifier of the entity to update.

Headers

x-api-keystringRequired

Request

This endpoint expects an object.
namestringOptional
The new name for the entity.
descriptionstringOptional
An updated description for the entity.
metadataobjectOptional

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

The entity has been successfully updated.
_idstring or null
The unique identifier of the entity.
namestring or null
The name of the entity.
descriptionstring or null
A description of the entity.
metadataobject or null
Custom metadata for the entity.
asset_idslist of strings or null
An array of asset IDs associated with the entity.
statusenum or null

The current status of the entity creation process. Possible values are:

  • 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.
Allowed values:
created_atstring or nullformat: "date-time"

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

updated_atstring or nullformat: "date-time"

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

Errors