Sign in

v8

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

Update existing field

This API updates the label or schema of an existing custom metadata field.

patch/v1/customMetadataFields/{id}

Path parameters

idstring required

Should be a valid custom metadata field id.

Request body

labelstring

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. This parameter is required if schema is not provided.

Example request

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

Response

Custom metadata field updated 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"
    ]
  }
}