Set a metafield

post /rest/api/{ownerResource}/{ownerId}/metafields

Creates a Metafield resource.

Stores a metafield value on the owner record identified by ownerResource and ownerId. Reference the definition the value belongs to and give it a value - it is validated against the definition’s type and validations.

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.
X-Flowkiwi-Locale	string	-	Specifies the locale for properties that support localization. If not provided, the default locale will be used.
X-Flowkiwi-Locale-Fallback	boolean	-	Enables the use of a fallback locale. If a property lacks a translation for the requested locale, the value from the default locale will be used.

Path parameters

Name	Type	Required	Description
ownerResource	string	required	The owner resource type the metafields are scoped to (e.g. "products", "variants"); must match the definition's ownerType.
ownerId	string	required	The id of the owner record the metafields belong to.

Request body

Property	Type	Required	Description
value	string | null	required
definition	MetafieldDefinition.MetafieldDefinitionCreateInput	required	The MetafieldDefinition this metafield is an instance of.
Show definition fields Property Type Required Description name string - description string | null - namespace string - key string - ownerType string required type string required 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

201 - Metafield resource created

Property	Type	Required	Description
@context	object	-
@id	string	required
@type	string	required
id	string	-	The resource's unique identifier (UUID).
value	string	-	This property supports translations. The data stored in the metafield. Always stored as a string, regardless of the metafield's type.
ownerId	string | null	-	The id of the owner record the metafield is attached to.
definition	string	-	The MetafieldDefinition this metafield is an instance of.
ownerResource	string	required	The type of resource that the metafield is attached to.
metaobject	string[]	-	The referenced metaobject(s). Populated when ?expand=metaobject is requested and the field type is metaobject_reference or list__metaobject_reference.
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).

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	-