# gateConfigurationDelete - admin - MUTATION Version: unstable ## Description Deletes a gate configuration. ### Access Scopes `write_gates` access scope. Also: You must have write access to `gates` to delete gate configurations. ## Arguments * [input](/docs/api/admin/unstable/input-objects/GateConfigurationDeleteInput): GateConfigurationDeleteInput! - Specifies the gate configuration to delete by its ID. ## Returns * [deletedGateConfigurationId](/docs/api/admin/unstable/scalars/ID): ID The ID of the deleted gate configuration. * [shop](/docs/api/admin/unstable/objects/Shop): Shop! The shop associated with the gate configuration. * [userErrors](/docs/api/admin/unstable/objects/GateConfigurationUserError): GateConfigurationUserError! The list of errors that occurred from executing the mutation. ## Examples ### Delete a gate configuration by ID 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 gateConfigurationDelete($input: GateConfigurationDeleteInput!) { gateConfigurationDelete(input: $input) { userErrors { field message } deletedGateConfigurationId } }\",\n \"variables\": {\n \"input\": {\n \"id\": \"gid://shopify/GateConfiguration/43548663\"\n }\n }\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation gateConfigurationDelete($input: GateConfigurationDeleteInput!) {\n gateConfigurationDelete(input: $input) {\n userErrors {\n field\n message\n }\n deletedGateConfigurationId\n }\n }`,\n \"variables\": {\n \"input\": {\n \"id\": \"gid://shopify/GateConfiguration/43548663\"\n }\n },\n },\n});\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 gateConfigurationDelete($input: GateConfigurationDeleteInput!) {\n gateConfigurationDelete(input: $input) {\n userErrors {\n field\n message\n }\n deletedGateConfigurationId\n }\n }\nQUERY\n\nvariables = {\n \"input\": {\n \"id\": \"gid://shopify/GateConfiguration/43548663\"\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n" Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation gateConfigurationDelete($input: GateConfigurationDeleteInput!) {\n gateConfigurationDelete(input: $input) {\n userErrors {\n field\n message\n }\n deletedGateConfigurationId\n }\n }`,\n {\n variables: {\n \"input\": {\n \"id\": \"gid://shopify/GateConfiguration/43548663\"\n }\n },\n },\n);\n\nconst data = await response.json();\n" Graphql query: "mutation gateConfigurationDelete($input: GateConfigurationDeleteInput!) {\n gateConfigurationDelete(input: $input) {\n userErrors {\n field\n message\n }\n deletedGateConfigurationId\n }\n}" #### Graphql Input { "input": { "id": "gid://shopify/GateConfiguration/43548663" } } #### Graphql Response { "data": { "gateConfigurationDelete": { "userErrors": [], "deletedGateConfigurationId": "gid://shopify/GateConfiguration/43548663" } } } ### Deleting a gate configuration by an incorrect ID returns an error 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 gateConfigurationDelete($input: GateConfigurationDeleteInput!) { gateConfigurationDelete(input: $input) { userErrors { field message } deletedGateConfigurationId } }\",\n \"variables\": {\n \"input\": {\n \"id\": \"gid://shopify/GateConfiguration/0\"\n }\n }\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation gateConfigurationDelete($input: GateConfigurationDeleteInput!) {\n gateConfigurationDelete(input: $input) {\n userErrors {\n field\n message\n }\n deletedGateConfigurationId\n }\n }`,\n \"variables\": {\n \"input\": {\n \"id\": \"gid://shopify/GateConfiguration/0\"\n }\n },\n },\n});\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 gateConfigurationDelete($input: GateConfigurationDeleteInput!) {\n gateConfigurationDelete(input: $input) {\n userErrors {\n field\n message\n }\n deletedGateConfigurationId\n }\n }\nQUERY\n\nvariables = {\n \"input\": {\n \"id\": \"gid://shopify/GateConfiguration/0\"\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n" Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation gateConfigurationDelete($input: GateConfigurationDeleteInput!) {\n gateConfigurationDelete(input: $input) {\n userErrors {\n field\n message\n }\n deletedGateConfigurationId\n }\n }`,\n {\n variables: {\n \"input\": {\n \"id\": \"gid://shopify/GateConfiguration/0\"\n }\n },\n },\n);\n\nconst data = await response.json();\n" Graphql query: "mutation gateConfigurationDelete($input: GateConfigurationDeleteInput!) {\n gateConfigurationDelete(input: $input) {\n userErrors {\n field\n message\n }\n deletedGateConfigurationId\n }\n}" #### Graphql Input { "input": { "id": "gid://shopify/GateConfiguration/0" } } #### Graphql Response { "data": { "gateConfigurationDelete": { "userErrors": [ { "field": [ "input", "id" ], "message": "Unable to find gate record with id" } ], "deletedGateConfigurationId": null } } }