Sign in

v8

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-214977372.7 KB
Digital Asset Management (DAM)
Custom metadata fields

Create new field

This API creates a new custom metadata field. Once a custom metadata field is created either through this API or using the dashboard UI, its value can be set on the assets. The value of a field for an asset can be set using the media library UI or programmatically through upload or update assets API.

post/v1/customMetadataFields

Request body

namestring required

API name of the custom metadata field. This should be unique across all (including deleted) custom metadata fields.

labelstring required

Human readable name of the custom metadata field. This should be unique across all non deleted custom metadata fields. This name is displayed as form field label to the users while setting field value on an asset in the media library UI.

Example request

{
  "schema": {
    "selectOptions": [
      "small",
      "medium",
      "large",
      30,
      40,
      true
    ],
    "defaultValue": [
      true,
      10,
      "Hello"
    ]
  }
}

Response

Custom metadata field created successfully.

idstring required

Unique identifier for the custom metadata field. Use this to update the field.

namestring required

API name of the custom metadata field. This becomes the key while setting customMetadata (key-value object) for an asset using upload or update API.

labelstring required

Human readable name of the custom metadata field. This name is displayed as form field label to the users while setting field value on the asset in the media library UI.

Example response

{
  "schema": {
    "selectOptions": [
      "small",
      "medium",
      "large",
      30,
      40,
      true
    ],
    "defaultValue": [
      true,
      10,
      "Hello"
    ]
  }
}