gateConfigurationUpdate

mutationDeprecated

Requires write_gates access scope. Also: You must have write access to gates to update gate configurations.

Update a gate configuration. Gates API is being sunset and will be removed in a future version. Use metafields instead for gate configuration.

Arguments

Anchor to inputinput • GateConfigurationUpdateInput!required: Specifies the input fields to update a gate configuation.

Was this section helpful?

Anchor to GateConfigurationUpdatePayload returnsGateConfigurationUpdatePayload returns

Anchor to gateConfigurationgateConfiguration • GateConfiguration: The updated gate configuration.
Anchor to userErrorsuserErrors • [GateConfigurationUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Add metafields to a gate configuration metafields
Update a gate configuration's name
Updating a gate configuration with an incorrect ID returns an error
gateConfigurationUpdate reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation gateConfigurationUpdate($input: GateConfigurationUpdateInput!) {
6    gateConfigurationUpdate(input: $input) {
7      userErrors {
8        field
9        message
10      }
11      gateConfiguration {
12        id
13        reactions: metafield(namespace: "myapp", key: "reactions") {
14          id
15          type
16          value
17          description
18        }
19      }
20    }
21  }`,
22  {
23    variables: {
24      "input": {
25        "id": "gid://shopify/GateConfiguration/43548663",
26        "metafields": [
27          {
28            "key": "reactions",
29            "namespace": "myapp",
30            "description": "My second gate reaction",
31            "type": "json",
32            "value": "{\"reactions\":\"test\"}"
33          }
34        ]
35      }
36    },
37  },
38);
39
40const data = await response.json();
41

mutation gateConfigurationUpdate($input: GateConfigurationUpdateInput!) {
  gateConfigurationUpdate(input: $input) {
    userErrors {
      field
      message
    }
    gateConfiguration {
      id
      reactions: metafield(namespace: "myapp", key: "reactions") {
        id
        type
        value
        description
      }
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation gateConfigurationUpdate($input: GateConfigurationUpdateInput!) { gateConfigurationUpdate(input: $input) { userErrors { field message } gateConfiguration { id reactions: metafield(namespace: \"myapp\", key: \"reactions\") { id type value description } } } }",
 "variables": {
    "input": {
      "id": "gid://shopify/GateConfiguration/43548663",
      "metafields": [
        {
          "key": "reactions",
          "namespace": "myapp",
          "description": "My second gate reaction",
          "type": "json",
          "value": "{\"reactions\":\"test\"}"
        }
      ]
    }
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation gateConfigurationUpdate($input: GateConfigurationUpdateInput!) {
    gateConfigurationUpdate(input: $input) {
      userErrors {
        field
        message
      }
      gateConfiguration {
        id
        reactions: metafield(namespace: "myapp", key: "reactions") {
          id
          type
          value
          description
        }
      }
    }
  }`,
  {
    variables: {
      "input": {
        "id": "gid://shopify/GateConfiguration/43548663",
        "metafields": [
          {
            "key": "reactions",
            "namespace": "myapp",
            "description": "My second gate reaction",
            "type": "json",
            "value": "{\"reactions\":\"test\"}"
          }
        ]
      }
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation gateConfigurationUpdate($input: GateConfigurationUpdateInput!) {
      gateConfigurationUpdate(input: $input) {
        userErrors {
          field
          message
        }
        gateConfiguration {
          id
          reactions: metafield(namespace: "myapp", key: "reactions") {
            id
            type
            value
            description
          }
        }
      }
    }`,
    "variables": {
      "input": {
        "id": "gid://shopify/GateConfiguration/43548663",
        "metafields": [
          {
            "key": "reactions",
            "namespace": "myapp",
            "description": "My second gate reaction",
            "type": "json",
            "value": "{\"reactions\":\"test\"}"
          }
        ]
      }
    },
  },
});

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 gateConfigurationUpdate($input: GateConfigurationUpdateInput!) {
    gateConfigurationUpdate(input: $input) {
      userErrors {
        field
        message
      }
      gateConfiguration {
        id
        reactions: metafield(namespace: "myapp", key: "reactions") {
          id
          type
          value
          description
        }
      }
    }
  }
QUERY

variables = {
  "input": {
    "id": "gid://shopify/GateConfiguration/43548663",
    "metafields": [{"key"=>"reactions", "namespace"=>"myapp", "description"=>"My second gate reaction", "type"=>"json", "value"=>"{\"reactions\":\"test\"}"}]
  }
}

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

Input variables

JSON

1{
2  "input": {
3    "id": "gid://shopify/GateConfiguration/43548663",
4    "metafields": [
5      {
6        "key": "reactions",
7        "namespace": "myapp",
8        "description": "My second gate reaction",
9        "type": "json",
10        "value": "{\"reactions\":\"test\"}"
11      }
12    ]
13  }
14}

Response

JSON

1{
2  "gateConfigurationUpdate": {
3    "userErrors": [],
4    "gateConfiguration": {
5      "id": "gid://shopify/GateConfiguration/43548663",
6      "reactions": {
7        "id": "gid://shopify/Metafield/1069229041",
8        "type": "json",
9        "value": "{\"reactions\":\"test\"}",
10        "description": "My second gate reaction"
11      }
12    }
13  }
14}