Partial update video information

This method will be deprecated in a future version. New implementations should use the Partial update indexed asset method.

This method updates one or more fields of the metadata of a video. Also, can delete a field by setting it to null.

<Info>This method will be deprecated in a future version. New implementations should use the [Partial update indexed asset](/v1.3/api-reference/index-content/update) method.</Info> This method updates one or more fields of the metadata of a video. Also, can delete a field by setting it to `null`.

Authentication

x-api-keystring

Your API key.

Note

You can find your API key on the API Keys page.

Your API key. <Note title="Note"> You can find your API key on the <a href="https://playground.twelvelabs.io/dashboard/api-keys" target="_blank">API Keys</a> page. </Note>

Path parameters

index-idstringRequired

The unique identifier of the index to which the video has been uploaded.

video-idstringRequired

The unique identifier of the video to update.

Request

Request to update the metadata of a video. Delete the fields with a null value.

user_metadatamap from strings to strings or integers or doubles or booleans or lists of stringsOptional

Example:

"user_metadata": {
  "category": "recentlyAdded",
  "batchNumber": 5,
  "rating": 9.3,
  "needsReview": true,
  "hashtags": ["summer", "vlog"]
}

Metadata that helps you categorize your assets. The object contains user-defined keys and values, where keys are strings. Each value is a string, a number, a boolean, or an array of strings. Send an integer wider than 53 bits (-9007199254740991 to 9007199254740991), and any identifier you want preserved verbatim, as a string. **Example**: ```JSON "user_metadata": { "category": "recentlyAdded", "batchNumber": 5, "rating": 9.3, "needsReview": true, "hashtags": ["summer", "vlog"] } ```

Errors

400

Bad Request Error