put
https://{subdomain}.myshoplaza.com/openapi/2025-06/metafield_definition/
Update an existing metafield definition.
The Update Metafield Definition API allows developers to update an existing metafield definition for a specified metadfield definition id.
This API is especially useful for:
- Modifying the display name or description of an existing metafield.
- Maintaining accurate documentation for custom fields.
- Adapting metafield definitions to evolving business requirements.
Request Parameters
Public Request Parameters
Path Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
id | string | Yes | Unique identifier of the metafield definition to update | "mfd_12345" |
Body Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
name | string | No | Updated display name for the metafield | "Warehouse Section" |
description | string | No | Revised description of the metafield | "Stores aisle and shelf location" |
Response Explanation
Public Response Parameters
Successful Response
| Parameter | Type | Example | Description |
|---|---|---|---|
code | string | "success" | Status code of the operation |
message | string | Human-readable result message | |
data.metafield_definition | object | {...} | The created metafield definition object |
data.metafield_definition.id | string | "mfd_67890" | Unique identifier of the definition |
data.metafield_definition.key | string | "warehouse_location" | Metafield key |
data.metafield_definition.name | string | "Warehouse Location" | Display name |
data.metafield_definition.namespace | string | "inventory" | Namespace grouping |
data.metafield_definition.owner_resource | string | "products" | Associated resource type |
data.metafield_definition.type | string | "single_line_text_field" | Data type of the metafield |
data.metafield_definition.description | string | "Stores warehouse bin ID" | Field purpose explanation |
data.metafield_definition.created_at | string | "2025-06-01T12:00:00Z" | Creation timestamp (ISO 8601) |
data.metafield_definition.updated_at | string | "2025-06-01T12:00:00Z" | Last update timestamp (ISO 8601) |
Error Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |