Update collection

Required roles:

can_write_collections

patch/v1/collections/{collection_id}/

Request

Base URL
https://app.iconik.io/API/assets
Auth
none declared. Required headers: App-ID, Auth-Token
TypeScript
https://skmtc.dev/iconik/apis/iconik-assets/docs/v1/collections/:collection_id/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

collection_idstring required

Query parameters

change_parent_modestring

Set to 'move' or 'copy'. Ignored if 'parent_id' hasn't changed

low_priority_indexingboolean

If true, the collection is reindexed using the low priority queue

Headers

App-IDstring required

Auth-Tokenstring required

Request body

categorystring nullable

custom_keyframestring uuid nullable

custom_posterstring uuid nullable

date_createdstring date-time

external_idstring nullable

is_rootboolean

keyframe_asset_idsstring[]

parent_idstring uuid nullable

status'ACTIVE' | 'HIDDEN' | 'DELETED'

storage_idstring uuid nullable

titlestring required

Response

Returns an updated collection

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