Create a metafield definition validation

post /rest/api/metafield_definition_validations

Creates a MetafieldDefinitionValidation resource.

Adds a validation rule to a metafield definition. Reference the metafieldDefinition, the validation name (type) and its value. The rule must be compatible with the definition’s type, otherwise it is rejected with 422.

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.

Request body

Property	Type	Required	Description
metafieldDefinition	string	required	The metafield definition this validation belongs to.
name	string	required	The type of validation rule.
value	string	required	The validation parameter value. Format depends on the validation type.

Response

201 - MetafieldDefinitionValidation resource created

Property	Type	Required	Description
@context	object	-
@id	string	required
@type	string	required
id	string	-	The resource's unique identifier (UUID).
metafieldDefinition	string	required	The metafield definition this validation belongs to
name	string	required	The type of validation rule
value	string	required	The validation parameter value. Format depends on the validation type.

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.

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	-