standardMetafieldDefinitionEnable

mutation

Requires API client to have access to the resource type associated with the metafield definition owner type.

Activates the specified standard metafield definition from its template.

Refer to the list of standard metafield definition templates.

Arguments

Anchor to idid • ID: The ID of the standard metafield definition template to enable.
Anchor to keykey • String: The key of the standard metafield to enable. Used in combination with namespace.
Anchor to namespacenamespace • String: The namespace of the standard metafield to enable. Used in combination with key.
Anchor to ownerTypeownerType • MetafieldOwnerType!required: The resource type that the metafield definition is scoped to.
Anchor to pinpin • Boolean!requiredDefault:false: Whether to pin the metafield definition.
Anchor to useAsCollectionConditionuseAsCollectionCondition • BooleanDefault:false: Whether the metafield definition can be used as a collection condition.
Anchor to visibleToStorefrontApivisibleToStorefrontApi • BooleanDefault:null: Whether metafields for the definition are visible using the Storefront API.

Was this section helpful?

Anchor to StandardMetafieldDefinitionEnablePayload returnsStandardMetafieldDefinitionEnablePayload returns

Anchor to createdDefinitioncreatedDefinition • MetafieldDefinition: The metafield definition that was created.
Anchor to userErrorsuserErrors • [StandardMetafieldDefinitionEnableUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Creates a metafield definition from an existing template
standardMetafieldDefinitionEnable reference

Examples

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

mutation standardMetafieldDefinitionEnable($id: ID!, $ownerType: MetafieldOwnerType!, $pin: Boolean!, $visibleToStorefrontApi: Boolean!) {

standardMetafieldDefinitionEnable(id: $id, ownerType: $ownerType, pin: $pin, visibleToStorefrontApi: $visibleToStorefrontApi) {

createdDefinition {

name

key

namespace

description

}

userErrors {

field

message

}

}`,

{

variables: {

"id": "gid://shopify/StandardMetafieldDefinitionTemplate/2",

"ownerType": "PRODUCT",

"pin": false,

mutation standardMetafieldDefinitionEnable($id: ID!, $ownerType: MetafieldOwnerType!, $pin: Boolean!, $visibleToStorefrontApi: Boolean!) {
  standardMetafieldDefinitionEnable(id: $id, ownerType: $ownerType, pin: $pin, visibleToStorefrontApi: $visibleToStorefrontApi) {
    createdDefinition {
      name
      key
      namespace
      description
    }
    userErrors {
      field
      message
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation standardMetafieldDefinitionEnable($id: ID!, $ownerType: MetafieldOwnerType!, $pin: Boolean!, $visibleToStorefrontApi: Boolean!) { standardMetafieldDefinitionEnable(id: $id, ownerType: $ownerType, pin: $pin, visibleToStorefrontApi: $visibleToStorefrontApi) { createdDefinition { name key namespace description } userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/StandardMetafieldDefinitionTemplate/2",
    "ownerType": "PRODUCT",
    "pin": false,
    "visibleToStorefrontApi": true
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation standardMetafieldDefinitionEnable($id: ID!, $ownerType: MetafieldOwnerType!, $pin: Boolean!, $visibleToStorefrontApi: Boolean!) {
    standardMetafieldDefinitionEnable(id: $id, ownerType: $ownerType, pin: $pin, visibleToStorefrontApi: $visibleToStorefrontApi) {
      createdDefinition {
        name
        key
        namespace
        description
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/StandardMetafieldDefinitionTemplate/2",
      "ownerType": "PRODUCT",
      "pin": false,
      "visibleToStorefrontApi": true
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation standardMetafieldDefinitionEnable($id: ID!, $ownerType: MetafieldOwnerType!, $pin: Boolean!, $visibleToStorefrontApi: Boolean!) {
      standardMetafieldDefinitionEnable(id: $id, ownerType: $ownerType, pin: $pin, visibleToStorefrontApi: $visibleToStorefrontApi) {
        createdDefinition {
          name
          key
          namespace
          description
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/StandardMetafieldDefinitionTemplate/2",
      "ownerType": "PRODUCT",
      "pin": false,
      "visibleToStorefrontApi": true
    },
  },
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation standardMetafieldDefinitionEnable($id: ID!, $ownerType: MetafieldOwnerType!, $pin: Boolean!, $visibleToStorefrontApi: Boolean!) {
    standardMetafieldDefinitionEnable(id: $id, ownerType: $ownerType, pin: $pin, visibleToStorefrontApi: $visibleToStorefrontApi) {
      createdDefinition {
        name
        key
        namespace
        description
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/StandardMetafieldDefinitionTemplate/2",
  "ownerType": "PRODUCT",
  "pin": false,
  "visibleToStorefrontApi": true
}

response = client.query(query: query, variables: variables)

Input variables

JSON

{

"id": "gid://shopify/StandardMetafieldDefinitionTemplate/2",

"ownerType": "PRODUCT",

"pin": false,

"visibleToStorefrontApi": true

}

Response

JSON

{

"standardMetafieldDefinitionEnable": {

"createdDefinition": {

"name": "Care guide",

"key": "care_guide",

"namespace": "descriptors",

"description": "Instructions for taking care of a product or apparel"

"userErrors": []

}