metafieldDefinitionUpdate mutation

Version unstable

Updates a metafield definition.

Required access

API client must have access to resource type associate with metafield definition.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Argument Description
definition ( MetafieldDefinitionUpdateInput! ) required

Specifies the input fields for the metafield definition update.

MetafieldDefinitionUpdateInput fields

  • description (String)

    The updated value for the metafield definition's description.

  • key (String!) Required

    The key for the metafield definition.

  • name (String)

    The updated value for the metafield definition's name.

  • namespace (String!) Required

    The namespace for the metafield definition.

  • ownerType (MetafieldOwnerType!) Required

    The resource type that the metafield definition is scoped to.

  • pin (Boolean)

    Sets whether the metafield definition should be pinned or unpinned.

Return fields