ICiconik

Update metadata for collection

Required roles:

  • can_reindex_collections
put/v1/collections/{collection_id}/search_document/

Request

Path parameters

collection_idstring required

Headers

App-IDstring required
Auth-Tokenstring required

Request body

categorystring nullable
created_by_userstring uuid
custom_keyframestring uuid nullable
custom_order_status'DISABLED' | 'ENABLING' | 'ENABLED'
custom_posterstring uuid nullable
date_createdstring date-time
date_deletedstring date-time
date_modifiedstring date-time
date_viewedstring date-time
deleted_by_userstring uuid
external_idstring nullable
favouredboolean
idstring uuid
in_collectionsstring[]
is_rootboolean
keyframe_asset_idsstring[]
keyframesobject[]
metadataobject
object_typestring
parent_idstring uuid nullable
parentsstring[]
permissionsstring[]
positioninteger
project_idstring uuid
status'ACTIVE' | 'HIDDEN' | 'DELETED'
storage_idstring uuid nullable
titlestring required

Response

Collection metadata updated

Changes

No recorded changes to this operation across all 1 revision of this API.