Update a metaobject definition

patch /api/metaobject_definitions/{id}

Updates the MetaobjectDefinition resource.

Partially updates a metaobject definition. The body is a JSON Merge Patch document: change the name, displayNameField, or the fieldDefinitions.

Path parameters

Name	Type	Required	Description
`id`	`string`	required	MetaobjectDefinition identifier

Request body

Property Type Required Description

description string | null -

displayNameField string | null - The key of the field definition used as the display name for records of this type. Optional - when omitted it is null and records have no derived display name. When set, it must match the key of one of this definition's fieldDefinitions, otherwise the request is rejected with 422.

fieldDefinitions EmbeddedMetaobjectFieldDefinitionResource[] - The field definitions that make up this metaobject definition.

Show fieldDefinitions fields

Property Type Required Description

description string | null - An optional description of the field.

key string required The field key, unique within the definition (referenced by metaobject fields).

name string required The human-readable name of the field.

required boolean - Whether a value for this field is required on metaobjects of the definition.

type "/api/metafield_definition_types/single_line_text_field" | "/api/metafield_definition_types/multi_line_text_field" | "/api/metafield_definition_types/number_integer" | "/api/metafield_definition_types/number_decimal" | "/api/metafield_definition_types/json" | "/api/metafield_definition_types/list__single_line_text_field" | "/api/metafield_definition_types/list__number_integer" | "/api/metafield_definition_types/list__number_decimal" | "/api/metafield_definition_types/list__product_reference" | "/api/metafield_definition_types/list__media_reference" | "/api/metafield_definition_types/product_reference" | "/api/metafield_definition_types/media_reference" | "/api/metafield_definition_types/metaobject_reference" | "/api/metafield_definition_types/list__metaobject_reference" required The field data type, as an IRI to the field-type resource.

Immutable once the field definition exists: a PATCH changing it is rejected with a 422. Delete the field and add the key back to use another type.

validations EmbeddedMetafieldDefinitionValidationResource[] - The validation rules applied to values of this field.

Show validations fields

Property	Type	Required	Description
`name`	`"/api/metafield_definition_validation_types/min_length" \| "/api/metafield_definition_validation_types/max_length" \| "/api/metafield_definition_validation_types/min_value" \| "/api/metafield_definition_validation_types/max_value" \| "/api/metafield_definition_validation_types/max_precision" \| "/api/metafield_definition_validation_types/json_schema" \| "/api/metafield_definition_validation_types/media_type" \| "/api/metafield_definition_validation_types/metaobject_definition"`	required	The type of validation rule
`value`	`string`	required	The validation parameter value. Format depends on the validation type.

name string | null -

Response

200 - MetaobjectDefinition resource updated

Format

Property Type Required Description

@context string | object -

@id string required

@type string required

createdAt string - The date and time when the resource was created (ISO 8601 format).

description string | null - The description of the metaobject definition.

fieldDefinitions EmbeddedMetaobjectFieldDefinitionResource[] - The field definitions that make up this metaobject definition.

Show fieldDefinitions fields

Property Type Required Description

description string | null - An optional description of the field.

id string - The resource's unique identifier (UUID).

key string required The field key, unique within the definition (referenced by metaobject fields).

name string required The human-readable name of the field.

required boolean - Whether a value for this field is required on metaobjects of the definition.

validations EmbeddedMetafieldDefinitionValidationResource[] - The validation rules applied to values of this field.

Show validations fields

Property	Type	Required	Description
`name`	`"/api/metafield_definition_validation_types/min_length" \| "/api/metafield_definition_validation_types/max_length" \| "/api/metafield_definition_validation_types/min_value" \| "/api/metafield_definition_validation_types/max_value" \| "/api/metafield_definition_validation_types/max_precision" \| "/api/metafield_definition_validation_types/json_schema" \| "/api/metafield_definition_validation_types/media_type" \| "/api/metafield_definition_validation_types/metaobject_definition"`	required	The type of validation rule
`value`	`string`	required	The validation parameter value. Format depends on the validation type.

id string - The resource's unique identifier (UUID).

name string required The human-readable name of the metaobject definition.

type string required The unique slug identifier for this metaobject definition.

updatedAt string - The date and time when the resource was last modified (ISO 8601 format).

Property Type Required Description

createdAt string - The date and time when the resource was created (ISO 8601 format).

description string | null - The description of the metaobject definition.

fieldDefinitions EmbeddedMetaobjectFieldDefinitionResource[] - The field definitions that make up this metaobject definition.

Show fieldDefinitions fields

Property Type Required Description

description string | null - An optional description of the field.

id string - The resource's unique identifier (UUID).

key string required The field key, unique within the definition (referenced by metaobject fields).

name string required The human-readable name of the field.

required boolean - Whether a value for this field is required on metaobjects of the definition.

validations EmbeddedMetafieldDefinitionValidationResource[] - The validation rules applied to values of this field.

Show validations fields

Property	Type	Required	Description
`name`	`"/api/metafield_definition_validation_types/min_length" \| "/api/metafield_definition_validation_types/max_length" \| "/api/metafield_definition_validation_types/min_value" \| "/api/metafield_definition_validation_types/max_value" \| "/api/metafield_definition_validation_types/max_precision" \| "/api/metafield_definition_validation_types/json_schema" \| "/api/metafield_definition_validation_types/media_type" \| "/api/metafield_definition_validation_types/metaobject_definition"`	required	The type of validation rule
`value`	`string`	required	The validation parameter value. Format depends on the validation type.

id string - The resource's unique identifier (UUID).

name string required The human-readable name of the metaobject definition.

type string required The unique slug identifier for this metaobject definition.

updatedAt string - The date and time when the resource was last modified (ISO 8601 format).

Errors

400 - Invalid input

Format

Property	Type	Required	Description
`@context`	`string \| object`	-
`@id`	`string`	required
`@type`	`string`	required
`code`	`string`	-	Stable identifier of the error in the error code catalogue (see /api/error-codes). Present on catalogued errors only.
`description`	`string \| null`	-
`detail`	`string \| null`	-	A human-readable explanation specific to this occurrence of the problem.
`instance`	`string \| null`	-	A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
`message`	`string`	-	End-user message localized in the request locale, with this occurrence's values substituted. Present on catalogued errors only.
`slug`	`string`	-	Stable, readable key of the error in the error code catalogue. Present on catalogued errors only.
`status`	`integer \| null`	-
`title`	`string \| null`	-	A short, human-readable summary of the problem. For a catalogued error it repeats the `slug`.
`type`	`string`	-	A URI reference that identifies the problem type. For a catalogued error it is the error code resource, `/api/error-codes/{code}`.

Property	Type	Required	Description
`code`	`string`	-	Stable identifier of the error in the error code catalogue (see /api/error-codes). Present on catalogued errors only.
`detail`	`string \| null`	-	A human-readable explanation specific to this occurrence of the problem.
`instance`	`string \| null`	-	A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
`message`	`string`	-	End-user message localized in the request locale, with this occurrence's values substituted. Present on catalogued errors only.
`slug`	`string`	-	Stable, readable key of the error in the error code catalogue. Present on catalogued errors only.
`status`	`integer \| null`	-
`title`	`string \| null`	-	A short, human-readable summary of the problem. For a catalogued error it repeats the `slug`.
`type`	`string`	-	A URI reference that identifies the problem type. For a catalogued error it is the error code resource, `/api/error-codes/{code}`.

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

Content-Type: application/problem+json

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

404 - Not found

Format

Property	Type	Required	Description
`@context`	`string \| object`	-
`@id`	`string`	required
`@type`	`string`	required
`code`	`string`	-	Stable identifier of the error in the error code catalogue (see /api/error-codes). Present on catalogued errors only.
`description`	`string \| null`	-
`detail`	`string \| null`	-	A human-readable explanation specific to this occurrence of the problem.
`instance`	`string \| null`	-	A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
`message`	`string`	-	End-user message localized in the request locale, with this occurrence's values substituted. Present on catalogued errors only.
`slug`	`string`	-	Stable, readable key of the error in the error code catalogue. Present on catalogued errors only.
`status`	`integer \| null`	-
`title`	`string \| null`	-	A short, human-readable summary of the problem. For a catalogued error it repeats the `slug`.
`type`	`string`	-	A URI reference that identifies the problem type. For a catalogued error it is the error code resource, `/api/error-codes/{code}`.

Property	Type	Required	Description
`code`	`string`	-	Stable identifier of the error in the error code catalogue (see /api/error-codes). Present on catalogued errors only.
`detail`	`string \| null`	-	A human-readable explanation specific to this occurrence of the problem.
`instance`	`string \| null`	-	A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
`message`	`string`	-	End-user message localized in the request locale, with this occurrence's values substituted. Present on catalogued errors only.
`slug`	`string`	-	Stable, readable key of the error in the error code catalogue. Present on catalogued errors only.
`status`	`integer \| null`	-
`title`	`string \| null`	-	A short, human-readable summary of the problem. For a catalogued error it repeats the `slug`.
`type`	`string`	-	A URI reference that identifies the problem type. For a catalogued error it is the error code resource, `/api/error-codes/{code}`.

422 - An error occurred

Format

Property Type Required Description

@context string | object -

@id string required

@type string required

description string -

detail string -

instance string | null -

status integer -

title string | null -

type string -

violations object[] -

Show violations fields

Property	Type	Required	Description
`code`	`string`	-	The code of the violation
`hint`	`string`	-	An extra hint to understand the violation
`message`	`string`	required	The message associated with the violation
`parameters`	`object`	-	Dynamic placeholder values for the violation message template (substitute into the code catalogue message).
`payload`	`object`	-	The serialized payload of the violation
`propertyPath`	`string`	required	The property path of the violation
`slug`	`string`	-	Stable centralized error-code slug for this violation (see /api/error-codes).

Property Type Required Description

detail string -

instance string | null -

status integer -

title string | null -

type string -

violations object[] -

Show violations fields

Property	Type	Required	Description
`code`	`string`	-	The code of the violation
`hint`	`string`	-	An extra hint to understand the violation
`message`	`string`	required	The message associated with the violation
`parameters`	`object`	-	Dynamic placeholder values for the violation message template (substitute into the code catalogue message).
`payload`	`object`	-	The serialized payload of the violation
`propertyPath`	`string`	required	The property path of the violation
`slug`	`string`	-	Stable centralized error-code slug for this violation (see /api/error-codes).