Skip to main content
Anchor to MetafieldDefinitionUpdatePayload

MetafieldDefinitionUpdatePayload

payload

Return type for metafieldDefinitionUpdate mutation.

Anchor to FieldsFields

Anchor to updatedDefinitionupdatedDefinition
•MetafieldDefinition

The metafield definition that was updated.

Anchor to userErrorsuserErrors
•[MetafieldDefinitionUpdateUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Anchor to validationJobvalidationJob
•Job

The asynchronous job updating the metafield definition's validation_status.

Was this section helpful?

Anchor to Mutations with this payloadMutations with this payload

Anchor to metafieldDefinitionUpdatemetafieldDefinitionUpdate
•mutation

Updates a MetafieldDefinition's configuration and settings. You can modify the definition's name, description, validation rules, access settings, capabilities, and constraints.

The mutation updates access settings that control visibility across different APIs, such as the GraphQL Admin API, Storefront API, and Customer Account API. It also enables capabilities like admin filtering or unique value validation, and modifies constraints that determine which resource subtypes the definition applies to.

Note

The type, namespace, key, and owner type identify the definition and so can't be changed.

Learn more about updating metafield definitions.

Was this section helpful?