Replace the user-defined metadata of an asset

This method replaces the entire user-defined metadata of the specified asset. Unlike the PATCH method, which merges your changes with the existing metadata, this method overwrites the stored value in full:

A key with a value creates or replaces that key.
A key set to an empty string ("") or null is ignored.
A key you omit from the request body is removed.

To clear all metadata, send an empty object ({}) in the user_metadata field. This produces the same result as the DELETE method.

This method replaces the entire user-defined metadata of the specified asset. Unlike the [`PATCH`](/v1.3/api-reference/upload-content/direct-uploads/update-user-metadata) method, which merges your changes with the existing metadata, this method overwrites the stored value in full: - A key with a value creates or replaces that key. - A key set to an empty string (`""`) or `null` is ignored. - A key you omit from the request body is removed. To clear all metadata, send an empty object (`{}`) in the `user_metadata` field. This produces the same result as the [`DELETE`](/v1.3/api-reference/upload-content/direct-uploads/delete-user-metadata) method.

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

asset_idstringRequired

The unique identifier of the asset whose user-defined metadata to replace.

Request

This endpoint expects an object.

user_metadatamap from strings to anyRequired

Metadata that helps you categorize your assets. The object contains user-defined keys and values, where keys are strings and values are one of string, integer, float, or boolean.

Example:

1 "user_metadata": {
2   "category": "recentlyAdded",
3   "batchNumber": 5,
4   "rating": 9.3,
5   "needsReview": true
6 }

Note

To store other types of data, such as objects or arrays, convert your data into string values before sending it.

Metadata that helps you categorize your assets. The object contains user-defined keys and values, where keys are strings and values are one of `string`, `integer`, `float`, or `boolean`. **Example**: ```JSON "user_metadata": { "category": "recentlyAdded", "batchNumber": 5, "rating": 9.3, "needsReview": true } ``` <Note title="Note"> To store other types of data, such as objects or arrays, convert your data into string values before sending it. </Note>

Errors

400

Bad Request Error

404

Not Found Error

1	"user_metadata": {
2	"category": "recentlyAdded",
3	"batchNumber": 5,
4	"rating": 9.3,
5	"needsReview": true
6	}