---
title: "Update metadata for asset"
method: PUT
path: "/v1/assets/{asset_id}/search_document/"
deprecated: true
---

# Update metadata for asset

`PUT /v1/assets/{asset_id}/search_document/`

## Request

- Base URL: `https://app.iconik.io/API/assets`
- URL: `https://app.iconik.io/API/assets/v1/assets/{asset_id}/search_document/`
- Auth: none declared. Required headers: `App-ID`, `Auth-Token`
- TypeScript: <https://skmtc.dev/iconik/apis/iconik-assets/docs/v1/assets/:asset_id/search_document/put.ts> (a function with typed inputs; its response is checked against the schema)

> **Deprecated.**

Required roles:
 - can_reindex_assets

## Path parameters

- `asset_id` string, required

## Headers

- `App-ID` string, required
- `Auth-Token` string, required

## Request body

- AssetElasticSchema
  - `analyze_status` 'N/A' | 'REQUESTED' | 'IN_PROGRESS' | 'FAILED' | 'DONE'
  - `ancestor_collections` string[]: Unordered list of all ancestor collection ids
  - `approval` ApprovalSchema
    - `approvals_by` ApprovalBySchema[], nullable
      - `change_date` string, date-time
      - `external` string
      - `object_id` string, uuid
      - `object_type` string
      - `status` 'N/A' | 'REQUESTED' | 'APPROVED' | 'NOT_APPROVED' | 'MIXED'
      - `user` string, uuid
      - `version_id` string, uuid
    - `change_date` string, date-time
    - `externals` string[]
    - `groups` string[]
    - `min_number` integer
    - `object_id` string, uuid
    - `object_type` string
    - `request_date` string, date-time
    - `requested_by` string, uuid
    - `share_id` string, uuid, nullable
    - `status` 'N/A' | 'REQUESTED' | 'APPROVED' | 'NOT_APPROVED' | 'MIXED'
    - `user_status` 'N/A' | 'REQUESTED' | 'APPROVED' | 'NOT_APPROVED' | 'MIXED', nullable
    - `users` string[]
    - `users_info` User[]
      - `email` string, email
      - `first_name` string
      - `id` string, uuid
      - `last_name` string
      - `photo` string
      - `photo_big` string
      - `photo_small` string
    - `version_id` string, uuid
  - `archive_status` 'NOT_ARCHIVED' | 'ARCHIVING' | 'FAILED_TO_ARCHIVE' | 'ARCHIVED'
  - `category` string, nullable
  - `clip_id` integer, nullable: ID of the draft clip in the Wildmoka system that is linked to this asset.
  - `comments_count` integer
  - `created_by_user` string, uuid
  - `created_by_user_info` User
    - `email` string, email
    - `first_name` string
    - `id` string, uuid
    - `last_name` string
    - `photo` string
    - `photo_big` string
    - `photo_small` string
  - `custom_keyframe` string, uuid, nullable
  - `custom_poster` string, uuid, nullable
  - `date_created` string, date-time
  - `date_deleted` string, date-time
  - `date_imported` string, date-time
  - `date_modified` string, date-time
  - `date_viewed` string, date-time
  - `deleted_by_user` string, uuid
  - `deleted_by_user_info` User
    - `email` string, email
    - `first_name` string
    - `id` string, uuid
    - `last_name` string
    - `photo` string
    - `photo_big` string
    - `photo_small` string
  - `duration_milliseconds` integer
  - `external_id` string, nullable
  - `external_link` string, url, nullable
  - `face_recognition_status` 'N/A' | 'REQUESTED' | 'IN_PROGRESS' | 'FAILED' | 'DONE'
  - `favoured` boolean
  - `files` object[]
  - `formats` object[]
  - `has_unconfirmed_persons` boolean
  - `id` string, uuid
  - `in_collections` string[]
  - `is_blocked` boolean
  - `is_online` boolean
  - `keyframes` object[]
  - `last_archive_restore_date` string, date-time
  - `limit_download_to_groups` string[], nullable
  - `media_type` string, nullable
  - `metadata` object
  - `object_type` string
  - `original_asset_id` string, uuid
  - `original_segment_id` string, uuid
  - `original_version_id` string, uuid
  - `person_ids` string[]
  - `position` integer
  - `proxies` object[]
  - `relations` RelationElastic[]
    - `date_created` string, date-time
    - `date_modified` string, date-time
    - `description` string
    - `related_from_asset_id` string, uuid
    - `related_to_asset_id` string, uuid
    - `relation_type` string
  - `site_name` string, nullable
  - `status` 'ACTIVE' | 'DELETED'
  - `time_end_milliseconds` integer
  - `time_start_milliseconds` integer
  - `title` string, required
  - `type` 'ASSET' | 'SEQUENCE' | 'NLE_PROJECT' | 'PLACEHOLDER' | 'CUSTOM' | 'LINK' | 'SUBCLIP'
  - `updated_by_user` string, uuid
  - `updated_by_user_info` User
    - `email` string, email
    - `first_name` string
    - `id` string, uuid
    - `last_name` string
    - `photo` string
    - `photo_big` string
    - `photo_small` string
  - `versions` AssetVersion[]
    - `analyze_status` 'N/A' | 'REQUESTED' | 'IN_PROGRESS' | 'FAILED' | 'DONE'
    - `archive_status` 'NOT_ARCHIVED' | 'ARCHIVING' | 'FAILED_TO_ARCHIVE' | 'ARCHIVED'
    - `created_by_user` string, uuid
    - `created_by_user_info` User
      - `email` string, email
      - `first_name` string
      - `id` string, uuid
      - `last_name` string
      - `photo` string
      - `photo_big` string
      - `photo_small` string
    - `date_created` string, date-time
    - `face_recognition_status` 'N/A' | 'REQUESTED' | 'IN_PROGRESS' | 'FAILED' | 'DONE'
    - `has_unconfirmed_persons` boolean
    - `id` string, uuid
    - `is_online` boolean
    - `person_ids` string[]
    - `status` 'ACTIVE' | 'IN_PROGRESS' | 'FAILED' | 'DELETING' | 'DELETED'
    - `transcribe_status` 'N/A' | 'REQUESTED' | 'IN_PROGRESS' | 'FAILED' | 'DONE'
    - `transcribed_languages` string[]
    - `version_number` integer
  - `versions_number` integer
  - `warning` string, nullable

## Response `204`

Asset metadata updated

## Other responses

- `400`: No metadata supplied
- `401`: Token is invalid
- `404`: Asset does not exist in search index
- `default`: Error response

---

[API](https://skmtc.dev/iconik/apis/iconik-assets.md) - [All operations](https://skmtc.dev/iconik/apis/iconik-assets/llms.txt) - [OpenAPI document](https://skmtc.dev/iconik/apis/iconik-assets/revisions/62580d9e640e?raw)