Update a metaobject

patch /api/metaobjects/{id}

Updates the Metaobject resource.

Partially updates a metaobject. The body is a JSON Merge Patch document: change the status or individual fields values. Updated field values are re-validated against the definition.

Headers

Name	Type	Required	Description
`Flowkiwi-Locale`	`string`	-	Specifies the locale for properties that support localization. If not provided, the default locale will be used.

Path parameters

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

Request body

Property Type Required Description

fields MetaobjectFieldInput[] - The field values of the metaobject, one entry per field definition.

Show fields fields

Property	Type	Required	Description
`key`	`string`	required	The field key (matches a field definition key).
`value`	`string \| null`	-	This property supports translations. The field value, stored as a string regardless of the field type. Write it in the locale given by `Flowkiwi-Locale`.

status "DRAFT" | "ACTIVE" - The publication status of the metaobject.

Response

200 - Metaobject resource updated

Format

Property	Type	Required	Description
`@context`	`string \| object`	-
`@id`	`string`	required
`@type`	`string`	required
`definition`	`string \| null`	-	The `MetaobjectDefinition` (IRI) this metaobject is a record of. Requires the `metaobjects:read` scope. Returned null when the scope is missing.
`displayName`	`string \| null`	-	The human-readable label, derived from the field named by the definition's displayNameField.
`handle`	`string`	-	The metaobject's unique slug within its definition type.
`id`	`string`	-	The resource's unique identifier (UUID).
`status`	`"DRAFT" \| "ACTIVE"`	-	The publication status of the metaobject.

Property Type Required Description

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

definition string | null - The MetaobjectDefinition (IRI) this metaobject is a record of. Requires the metaobjects:read scope. Returned null when the scope is missing.

displayName string | null - The human-readable label, derived from the field named by the definition's displayNameField.

fields EmbeddedMetaobjectFieldResource[] - The field values of the metaobject, one entry per field definition.

Show fields fields

Property Type Required Description

key string - The field key (matches a field definition key).

metaobject Metaobject[] - The referenced metaobject(s). Populated when ?expand=metaobject is requested. Requires the metaobjects:read scope. Returned empty when the scope is missing.

Show metaobject fields

Property	Type	Required	Description
`createdAt`	`string`	-	The date and time when the resource was created (ISO 8601 format).
`definition`	`string \| null`	-	The `MetaobjectDefinition` (IRI) this metaobject is a record of. Requires the `metaobjects:read` scope. Returned null when the scope is missing.
`displayName`	`string \| null`	-	The human-readable label, derived from the field named by the definition's displayNameField.
`fields`	`EmbeddedMetaobjectFieldResource[]`	-	The field values of the metaobject, one entry per field definition.
`handle`	`string`	-	The metaobject's unique slug within its definition type.
`id`	`string`	-	The resource's unique identifier (UUID).
`status`	`"DRAFT" \| "ACTIVE"`	-	The publication status of the metaobject.
`updatedAt`	`string`	-	The date and time when the resource was last modified (ISO 8601 format).

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" - The field data type, as an IRI to the field-type resource.

value string | null - This property supports translations.

The field value, stored as a string regardless of the field type.

handle string - The metaobject's unique slug within its definition type.

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

status "DRAFT" | "ACTIVE" - The publication status of the metaobject.

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).