Anchor to section titled 'undefined'gate
gate
mutation
Unstable
Requires write access scope. Also: You must have write access to gates to update gate configurations.
Update a gate configuration.
Anchor to section titled 'Arguments'
Arguments
Specifies the input fields to update a gate configuation.
Was this section helpful?
Anchor to section titled 'GateConfigurationUpdatePayload returns'
GateConfigurationUpdatePayload returns
The updated gate configuration.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: gateConfigurationUpdate
Query Reference for MUTATION: gateConfigurationUpdate
"mutation gateConfigurationUpdate($input: GateConfigurationUpdateInput!) {\n gateConfigurationUpdate(input: $input) {\n gateConfiguration {\n # GateConfiguration fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: gateConfigurationUpdate
"{\n \"input\": {\n \"handle\": \"<your-handle>\",\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"metafields\": [\n {\n \"description\": \"<your-description>\",\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"key\": \"<your-key>\",\n \"namespace\": \"<your-namespace>\",\n \"type\": \"<your-type>\",\n \"value\": \"<your-value>\"\n }\n ],\n \"name\": \"<your-name>\"\n }\n}"Schema Reference for MUTATION: gateConfigurationUpdate
"input GateConfigurationUpdateInput {\n appId: String\n handle: String\n id: ID!\n metafields: [MetafieldInput!]\n name: String\n}\n\ninput MetafieldInput {\n description: String\n id: ID\n key: String\n namespace: String\n type: String\n value: String\n}\n"Display Examples for MUTATION: gateConfigurationUpdate
[
{
"example": {
"type_name": "gateconfigurationupdate",
"title": "Add metafields to a gate configuration metafields",
"query_string": "mutation gateConfigurationUpdate($input: GateConfigurationUpdateInput!) {\n gateConfigurationUpdate(input: $input) {\n userErrors {\n field\n message\n }\n gateConfiguration {\n id\n reactions: metafield(namespace: \"myapp\", key: \"reactions\") {\n id\n type\n value\n description\n }\n }\n }\n}",
"variables": {
"input": {
"id": "gid://shopify/GateConfiguration/43548663",
"metafields": [
{
"key": "reactions",
"namespace": "myapp",
"description": "My second gate reaction",
"type": "json",
"value": "{\"reactions\":\"test\"}"
}
]
}
},
"response": {
"data": {
"gateConfigurationUpdate": {
"userErrors": [],
"gateConfiguration": {
"id": "gid://shopify/GateConfiguration/43548663",
"reactions": {
"id": "gid://shopify/Metafield/1069229041",
"type": "json",
"value": "{\"reactions\":\"test\"}",
"description": "My second gate reaction"
}
}
}
}
},
"api_name": "admin",
"minimum_api_version": "unstable",
"maximum_api_version": "unstable",
"location": "/components/gates/test/unit/models/graph_api/admin/mutations/gate_configuration_update_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation gateConfigurationUpdate($input: GateConfigurationUpdateInput!) { gateConfigurationUpdate(input: $input) { userErrors { field message } gateConfiguration { id reactions: metafield(namespace: \\\"myapp\\\", key: \\\"reactions\\\") { id type value description } } } }\",\n \"variables\": {\n \"input\": {\n \"id\": \"gid://shopify/GateConfiguration/43548663\",\n \"metafields\": [\n {\n \"key\": \"reactions\",\n \"namespace\": \"myapp\",\n \"description\": \"My second gate reaction\",\n \"type\": \"json\",\n \"value\": \"{\\\"reactions\\\":\\\"test\\\"}\"\n }\n ]\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation gateConfigurationUpdate($input: GateConfigurationUpdateInput!) {\n gateConfigurationUpdate(input: $input) {\n userErrors {\n field\n message\n }\n gateConfiguration {\n id\n reactions: metafield(namespace: \"myapp\", key: \"reactions\") {\n id\n type\n value\n description\n }\n }\n }\n }`,\n {\n variables: {\n \"input\": {\n \"id\": \"gid://shopify/GateConfiguration/43548663\",\n \"metafields\": [\n {\n \"key\": \"reactions\",\n \"namespace\": \"myapp\",\n \"description\": \"My second gate reaction\",\n \"type\": \"json\",\n \"value\": \"{\\\"reactions\\\":\\\"test\\\"}\"\n }\n ]\n }\n },\n },\n);\n\nconst data = await response.json();\n",
"ruby_example": "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation gateConfigurationUpdate($input: GateConfigurationUpdateInput!) {\n gateConfigurationUpdate(input: $input) {\n userErrors {\n field\n message\n }\n gateConfiguration {\n id\n reactions: metafield(namespace: \"myapp\", key: \"reactions\") {\n id\n type\n value\n description\n }\n }\n }\n }\nQUERY\n\nvariables = {\n \"input\": {\n \"id\": \"gid://shopify/GateConfiguration/43548663\",\n \"metafields\": [{\"key\"=>\"reactions\", \"namespace\"=>\"myapp\", \"description\"=>\"My second gate reaction\", \"type\"=>\"json\", \"value\"=>\"{\\\"reactions\\\":\\\"test\\\"}\"}]\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation gateConfigurationUpdate($input: GateConfigurationUpdateInput!) {\n gateConfigurationUpdate(input: $input) {\n userErrors {\n field\n message\n }\n gateConfiguration {\n id\n reactions: metafield(namespace: \"myapp\", key: \"reactions\") {\n id\n type\n value\n description\n }\n }\n }\n }`,\n \"variables\": {\n \"input\": {\n \"id\": \"gid://shopify/GateConfiguration/43548663\",\n \"metafields\": [\n {\n \"key\": \"reactions\",\n \"namespace\": \"myapp\",\n \"description\": \"My second gate reaction\",\n \"type\": \"json\",\n \"value\": \"{\\\"reactions\\\":\\\"test\\\"}\"\n }\n ]\n }\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation gateConfigurationUpdate($input: GateConfigurationUpdateInput!) {\n gateConfigurationUpdate(input: $input) {\n userErrors {\n field\n message\n }\n gateConfiguration {\n id\n reactions: metafield(namespace: \"myapp\", key: \"reactions\") {\n id\n type\n value\n description\n }\n }\n }\n }\nQUERY;\n\n$variables = [\n \"input\" => [\n \"id\" => \"gid://shopify/GateConfiguration/43548663\",\n \"metafields\" => [{\"key\"=>\"reactions\", \"namespace\"=>\"myapp\", \"description\"=>\"My second gate reaction\", \"type\"=>\"json\", \"value\"=>\"{\\\"reactions\\\":\\\"test\\\"}\"}],\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "input",
"description": "Specifies the input fields to update a gate configuation.",
"type": {
"kind": "INPUT_OBJECT",
"name": "GateConfigurationUpdateInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "GateConfigurationUpdateInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "input",
"argValue": " {\"id\":\"gid://shopify/GateConfiguration/43548663\",\"metafields\":[{\"key\":\"reactions\",\"namespace\":\"myapp\",\"description\":\"My second gate reaction\",\"type\":\"json\",\"value\":\"{\\\"reactions\\\":\\\"test\\\"}\"}]}",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "gateconfigurationupdate",
"title": "Update a gate configuration's name",
"query_string": "mutation gateConfigurationUpdate($input: GateConfigurationUpdateInput!) {\n gateConfigurationUpdate(input: $input) {\n userErrors {\n field\n message\n }\n gateConfiguration {\n id\n name\n }\n }\n}",
"variables": {
"input": {
"id": "gid://shopify/GateConfiguration/43548663",
"name": "My second gate"
}
},
"response": {
"data": {
"gateConfigurationUpdate": {
"userErrors": [],
"gateConfiguration": {
"id": "gid://shopify/GateConfiguration/43548663",
"name": "My second gate"
}
}
}
},
"api_name": "admin",
"minimum_api_version": "unstable",
"maximum_api_version": "unstable",
"location": "/components/gates/test/unit/models/graph_api/admin/mutations/gate_configuration_update_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation gateConfigurationUpdate($input: GateConfigurationUpdateInput!) { gateConfigurationUpdate(input: $input) { userErrors { field message } gateConfiguration { id name } } }\",\n \"variables\": {\n \"input\": {\n \"id\": \"gid://shopify/GateConfiguration/43548663\",\n \"name\": \"My second gate\"\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation gateConfigurationUpdate($input: GateConfigurationUpdateInput!) {\n gateConfigurationUpdate(input: $input) {\n userErrors {\n field\n message\n }\n gateConfiguration {\n id\n name\n }\n }\n }`,\n {\n variables: {\n \"input\": {\n \"id\": \"gid://shopify/GateConfiguration/43548663\",\n \"name\": \"My second gate\"\n }\n },\n },\n);\n\nconst data = await response.json();\n",
"ruby_example": "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation gateConfigurationUpdate($input: GateConfigurationUpdateInput!) {\n gateConfigurationUpdate(input: $input) {\n userErrors {\n field\n message\n }\n gateConfiguration {\n id\n name\n }\n }\n }\nQUERY\n\nvariables = {\n \"input\": {\n \"id\": \"gid://shopify/GateConfiguration/43548663\",\n \"name\": \"My second gate\"\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation gateConfigurationUpdate($input: GateConfigurationUpdateInput!) {\n gateConfigurationUpdate(input: $input) {\n userErrors {\n field\n message\n }\n gateConfiguration {\n id\n name\n }\n }\n }`,\n \"variables\": {\n \"input\": {\n \"id\": \"gid://shopify/GateConfiguration/43548663\",\n \"name\": \"My second gate\"\n }\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation gateConfigurationUpdate($input: GateConfigurationUpdateInput!) {\n gateConfigurationUpdate(input: $input) {\n userErrors {\n field\n message\n }\n gateConfiguration {\n id\n name\n }\n }\n }\nQUERY;\n\n$variables = [\n \"input\" => [\n \"id\" => \"gid://shopify/GateConfiguration/43548663\",\n \"name\" => \"My second gate\",\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "input",
"description": "Specifies the input fields to update a gate configuation.",
"type": {
"kind": "INPUT_OBJECT",
"name": "GateConfigurationUpdateInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "GateConfigurationUpdateInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "input",
"argValue": " {\"id\":\"gid://shopify/GateConfiguration/43548663\",\"name\":\"My second gate\"}",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "gateconfigurationupdate",
"title": "Updating a gate configuration with an incorrect ID returns an error",
"query_string": "mutation gateConfigurationUpdate($input: GateConfigurationUpdateInput!) {\n gateConfigurationUpdate(input: $input) {\n userErrors {\n field\n message\n }\n gateConfiguration {\n id\n }\n }\n}",
"variables": {
"input": {
"id": "gid://shopify/GateConfiguration/0"
}
},
"response": {
"data": {
"gateConfigurationUpdate": {
"userErrors": [
{
"field": [
"input",
"id"
],
"message": "Unable to find gate record with id"
}
],
"gateConfiguration": null
}
}
},
"api_name": "admin",
"minimum_api_version": "unstable",
"maximum_api_version": "unstable",
"location": "/components/gates/test/unit/models/graph_api/admin/mutations/gate_configuration_update_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation gateConfigurationUpdate($input: GateConfigurationUpdateInput!) { gateConfigurationUpdate(input: $input) { userErrors { field message } gateConfiguration { id } } }\",\n \"variables\": {\n \"input\": {\n \"id\": \"gid://shopify/GateConfiguration/0\"\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation gateConfigurationUpdate($input: GateConfigurationUpdateInput!) {\n gateConfigurationUpdate(input: $input) {\n userErrors {\n field\n message\n }\n gateConfiguration {\n id\n }\n }\n }`,\n {\n variables: {\n \"input\": {\n \"id\": \"gid://shopify/GateConfiguration/0\"\n }\n },\n },\n);\n\nconst data = await response.json();\n",
"ruby_example": "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation gateConfigurationUpdate($input: GateConfigurationUpdateInput!) {\n gateConfigurationUpdate(input: $input) {\n userErrors {\n field\n message\n }\n gateConfiguration {\n id\n }\n }\n }\nQUERY\n\nvariables = {\n \"input\": {\n \"id\": \"gid://shopify/GateConfiguration/0\"\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation gateConfigurationUpdate($input: GateConfigurationUpdateInput!) {\n gateConfigurationUpdate(input: $input) {\n userErrors {\n field\n message\n }\n gateConfiguration {\n id\n }\n }\n }`,\n \"variables\": {\n \"input\": {\n \"id\": \"gid://shopify/GateConfiguration/0\"\n }\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation gateConfigurationUpdate($input: GateConfigurationUpdateInput!) {\n gateConfigurationUpdate(input: $input) {\n userErrors {\n field\n message\n }\n gateConfiguration {\n id\n }\n }\n }\nQUERY;\n\n$variables = [\n \"input\" => [\n \"id\" => \"gid://shopify/GateConfiguration/0\",\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "input",
"description": "Specifies the input fields to update a gate configuation.",
"type": {
"kind": "INPUT_OBJECT",
"name": "GateConfigurationUpdateInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "GateConfigurationUpdateInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "input",
"argValue": " {\"id\":\"gid://shopify/GateConfiguration/0\"}",
"typeKind": "MUTATION"
}
]
}
]