Update a metafield definition

patch /rest/api/metafield_definitions/{id}

Updates the MetafieldDefinition resource.

Partially updates a metafield definition. The body is a JSON Merge Patch document: include only the fields you want to change, such as the name, description or validations.

Identity is fixed

The namespace, key and ownerType identify the definition and the metafields already stored against it - change validations and presentation, but treat the identity fields as fixed.

Headers

Name	Type	Required	Description
X-Flowkiwi-Organization-Id	string	required	The organization the request acts as. Determines the identity, permissions and ownership applied when reading or modifying data on the instance.

Path parameters

Name	Type	Required	Description
id	string	required	MetafieldDefinition identifier

Request body

Property	Type	Required	Description
name	string | null	-
description	string | null	-
validations	EmbeddedMetafieldDefinitionValidationResource[]	-	The validation rules applied to the values of metafields using this definition.
Show validations fields Property Type Required Description name string required The type of validation rule value string required The validation parameter value. Format depends on the validation type.
constraints	EmbeddedMetafieldDefinitionConstraintResource[]	-	The constraint rules scoping where this metafield definition applies (e.g. by category or channel).
Show constraints fields Property Type Required Description key string required The type of constraint rule values string[] required Array of constraint values. Format depends on the constraint type.

Response

200 - MetafieldDefinition resource updated

Property	Type	Required	Description
@context	object	-
@id	string	required
@type	string	required
id	string	-	The resource's unique identifier (UUID).
name	string	-	The human-readable name of the metafield definition.
description	string | null	-	The description of the metafield definition.
namespace	string	-	The container for a group of metafields that the metafield definition is associated with.
key	string	-	The unique identifier for the metafield definition within its namespace.
ownerType	string	required	The resource type that the metafield definition is attached to.
type	string	required	The type of data that each of the metafields that belong to the metafield definition will store.
createdAt	string	-	The date and time when the resource was created (ISO 8601 format).
updatedAt	string	-	The date and time when the resource was last modified (ISO 8601 format).
validations	EmbeddedMetafieldDefinitionValidationResource[]	-	The validation rules applied to the values of metafields using this definition.
Show validations fields Property Type Required Description name string required The type of validation rule value string required The validation parameter value. Format depends on the validation type.
constraints	EmbeddedMetafieldDefinitionConstraintResource[]	-	The constraint rules scoping where this metafield definition applies (e.g. by category or channel).
Show constraints fields Property Type Required Description key string required The type of constraint rule values string[] required Array of constraint values. Format depends on the constraint type.
metafieldsCount	integer	-	The count of the metafields that belong to the metafield definition.

Errors

400 - Invalid input

Property	Type	Required	Description
@context	object	-
@id	string	required
@type	string	required
title	string | null	-	A short, human-readable summary of the problem.
detail	string | null	-	A human-readable explanation specific to this occurrence of the problem.
status	number | null	-
instance	string | null	-	A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
type	string	-	A URI reference that identifies the problem type

403 - Access denied. The caller is missing one or more identity permissions required for this operation.

Content-Type: application/problem+json

Property	Type	Required	Description
@context	object	-
@id	string	required
@type	string	required
type	string	-
title	string	-
status	integer	-
detail	string	-
missingPermissions	string[]	-	Identity permissions that the caller is missing for this operation. Present only when the 403 is caused by a denied identity:* permission.

404 - Not found

Property	Type	Required	Description
@context	object	-
@id	string	required
@type	string	required
title	string | null	-	A short, human-readable summary of the problem.
detail	string | null	-	A human-readable explanation specific to this occurrence of the problem.
status	number | null	-
instance	string | null	-	A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
type	string	-	A URI reference that identifies the problem type

422 - An error occurred

Property	Type	Required	Description
@context	object	-
@id	string	required
@type	string	required
status	integer	-
violations	object[]	-
Show violations fields Property Type Required Description propertyPath string required The property path of the violation message string required The message associated with the violation code string - The code of the violation hint string - An extra hint to understand the violation payload object - The serialized payload of the violation
detail	string	-
type	string	-
title	string | null	-
instance	string | null	-