PUT /v1/dataProducts

curl -X PUT "{base_url}/api/v1/dataProducts" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "CustomerInsights",
    "domains": ["Marketing"],
    "description": "Curated customer analytics data product",
    "owners": [],
    "experts": []
  }'

from metadata.sdk import configure
from metadata.sdk.entities import DataProducts

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# Retrieve, modify, and update
dp = DataProducts.retrieve("b1839f98-f046-5f35-bdef-20f9b3395cb2")
dp.description = "Updated: Curated customer analytics with enriched profiles"
updated = DataProducts.update(dp)

print(f"Updated to version {updated.version.root}")

// client is an initialized OpenMetadataClient.
var dataProductId = "b1839f98-f046-5f35-bdef-20f9b3395cb2";
var dataProduct = client.dataProducts().get(dataProductId);
dataProduct.setDescription("Updated: Curated customer analytics with enriched profiles");

var updated = client.dataProducts().update(dataProductId, dataProduct);

# Update by ID
curl -X PATCH "{base_url}/api/v1/dataProducts/b1839f98-f046-5f35-bdef-20f9b3395cb2" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Curated customer analytics with enriched profiles"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/dataProducts/name/CustomerInsights" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Curated customer analytics with enriched profiles"}
  ]'

{
  "id": "b1839f98-f046-5f35-bdef-20f9b3395cb2",
  "name": "CustomerInsights",
  "fullyQualifiedName": "CustomerInsights",
  "displayName": "Customer Insights",
  "description": "Updated: Curated customer analytics with enriched profiles",
  "version": 0.2,
  "updatedAt": 1769984330261,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/dataProducts/b1839f98-f046-5f35-bdef-20f9b3395cb2",
  "domains": [
    {
      "id": "a0729e98-e946-4e25-acde-10e8a2294ba1",
      "type": "domain",
      "name": "Marketing",
      "fullyQualifiedName": "Marketing",
      "deleted": false
    }
  ],
  "deleted": false,
  "owners": [],
  "experts": []
}

PUT

dataProducts

PUT /v1/dataProducts

curl -X PUT "{base_url}/api/v1/dataProducts" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "CustomerInsights",
    "domains": ["Marketing"],
    "description": "Curated customer analytics data product",
    "owners": [],
    "experts": []
  }'

from metadata.sdk import configure
from metadata.sdk.entities import DataProducts

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# Retrieve, modify, and update
dp = DataProducts.retrieve("b1839f98-f046-5f35-bdef-20f9b3395cb2")
dp.description = "Updated: Curated customer analytics with enriched profiles"
updated = DataProducts.update(dp)

print(f"Updated to version {updated.version.root}")

// client is an initialized OpenMetadataClient.
var dataProductId = "b1839f98-f046-5f35-bdef-20f9b3395cb2";
var dataProduct = client.dataProducts().get(dataProductId);
dataProduct.setDescription("Updated: Curated customer analytics with enriched profiles");

var updated = client.dataProducts().update(dataProductId, dataProduct);

# Update by ID
curl -X PATCH "{base_url}/api/v1/dataProducts/b1839f98-f046-5f35-bdef-20f9b3395cb2" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Curated customer analytics with enriched profiles"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/dataProducts/name/CustomerInsights" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Curated customer analytics with enriched profiles"}
  ]'

{
  "id": "b1839f98-f046-5f35-bdef-20f9b3395cb2",
  "name": "CustomerInsights",
  "fullyQualifiedName": "CustomerInsights",
  "displayName": "Customer Insights",
  "description": "Updated: Curated customer analytics with enriched profiles",
  "version": 0.2,
  "updatedAt": 1769984330261,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/dataProducts/b1839f98-f046-5f35-bdef-20f9b3395cb2",
  "domains": [
    {
      "id": "a0729e98-e946-4e25-acde-10e8a2294ba1",
      "type": "domain",
      "name": "Marketing",
      "fullyQualifiedName": "Marketing",
      "deleted": false
    }
  ],
  "deleted": false,
  "owners": [],
  "experts": []
}

Update a Data Product

Create a data product or update it if it already exists, using PUT /v1/dataProducts with the full request body. Send the complete definition, not just the fields you want to change. To change only some fields, use PATCH with a JSON Patch array and the application/json-patch+json content type, as shown in the PATCH examples below.

Body Parameters

string

required

Name of the data product. Must be unique across all data products.

array

required

Fully qualified names of the parent domains, for example ["Marketing"].

string

Human-readable display name for the data product.

string

required

Description of the data product in Markdown format.

array

Array of owner references (users or teams) to assign to the data product.

Show properties

string

UUID of the owner entity.

string

Type of owner entity, for example user, team.

string

Name of the owner entity.

array

Array of user names, as strings, of the subject matter experts for this data product.

PUT /v1/dataProducts

curl -X PUT "{base_url}/api/v1/dataProducts" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "CustomerInsights",
    "domains": ["Marketing"],
    "description": "Curated customer analytics data product",
    "owners": [],
    "experts": []
  }'

from metadata.sdk import configure
from metadata.sdk.entities import DataProducts

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# Retrieve, modify, and update
dp = DataProducts.retrieve("b1839f98-f046-5f35-bdef-20f9b3395cb2")
dp.description = "Updated: Curated customer analytics with enriched profiles"
updated = DataProducts.update(dp)

print(f"Updated to version {updated.version.root}")

// client is an initialized OpenMetadataClient.
var dataProductId = "b1839f98-f046-5f35-bdef-20f9b3395cb2";
var dataProduct = client.dataProducts().get(dataProductId);
dataProduct.setDescription("Updated: Curated customer analytics with enriched profiles");

var updated = client.dataProducts().update(dataProductId, dataProduct);

# Update by ID
curl -X PATCH "{base_url}/api/v1/dataProducts/b1839f98-f046-5f35-bdef-20f9b3395cb2" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Curated customer analytics with enriched profiles"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/dataProducts/name/CustomerInsights" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Curated customer analytics with enriched profiles"}
  ]'

{
  "id": "b1839f98-f046-5f35-bdef-20f9b3395cb2",
  "name": "CustomerInsights",
  "fullyQualifiedName": "CustomerInsights",
  "displayName": "Customer Insights",
  "description": "Updated: Curated customer analytics with enriched profiles",
  "version": 0.2,
  "updatedAt": 1769984330261,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/dataProducts/b1839f98-f046-5f35-bdef-20f9b3395cb2",
  "domains": [
    {
      "id": "a0729e98-e946-4e25-acde-10e8a2294ba1",
      "type": "domain",
      "name": "Marketing",
      "fullyQualifiedName": "Marketing",
      "deleted": false
    }
  ],
  "deleted": false,
  "owners": [],
  "experts": []
}

Returns

Returns the updated data product object with the new version number.

Response

string

Unique identifier for the data product (UUID format).

string

Data product name.

string

Fully qualified name of the data product. This is the data product name.

string

Updated description.

number

Incremented version number.

Error Handling

Code	Error Type	Description
`400`	`BAD_REQUEST`	Invalid or malformed request body
`401`	`UNAUTHORIZED`	Invalid or missing authentication token
`403`	`FORBIDDEN`	User lacks permission to update this data product
`409`	`CONFLICT`	Concurrent modification detected

API Reference

Data Assets

AI Assets

AI SDK

SDK

Discovery

Lineage

Data Contracts

Teams And Users

Data Governance

Data Quality

Alerts

Incidents

Main Concepts

Update a Data Product

Update a Data Product

Body Parameters

Returns

Response

Error Handling

​Update a Data Product

​Body Parameters

​Returns

​Response

​Error Handling

Update a Data Product

Body Parameters

Returns

Response

Error Handling