Anchor to section titled 'undefined'tags
tags
mutation
2024-10latest
Remove tags from an order, a draft order, a customer, a product, or an online store article.
Anchor to section titled 'Arguments'
Arguments
The ID of the resource to remove tags from.
A list of tags to remove from the resource in the form of an array of strings. Example value:
["tag1", "tag2", "tag3"].
Was this section helpful?
Anchor to section titled 'TagsRemovePayload returns'
TagsRemovePayload returns
The object that was updated.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: tagsRemove
Query Reference for MUTATION: tagsRemove
"mutation tagsRemove($id: ID!, $tags: [String!]!) {\n tagsRemove(id: $id, tags: $tags) {\n node {\n # Node fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: tagsRemove
"{\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"tags\": [\n \"<your-tags>\"\n ]\n}"Schema Reference for MUTATION: tagsRemove
""
Display Examples for MUTATION: tagsRemove
[
{
"example": {
"type_name": "tagsremove",
"title": "Remove tags from a customer",
"query_string": "mutation removeTags($id: ID!, $tags: [String!]!) {\n tagsRemove(id: $id, tags: $tags) {\n node {\n id\n }\n userErrors {\n message\n }\n }\n}",
"variables": {
"id": "gid://shopify/Customer/544365967",
"tags": [
"Bob"
]
},
"response": {
"data": {
"tagsRemove": {
"node": {
"id": "gid://shopify/Customer/544365967"
},
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/customers/test/unit/graph_api/admin/mutations/customer_tags_remove_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation removeTags($id: ID!, $tags: [String!]!) { tagsRemove(id: $id, tags: $tags) { node { id } userErrors { message } } }\",\n \"variables\": {\n \"id\": \"gid://shopify/Customer/544365967\",\n \"tags\": [\n \"Bob\"\n ]\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation removeTags($id: ID!, $tags: [String!]!) {\n tagsRemove(id: $id, tags: $tags) {\n node {\n id\n }\n userErrors {\n message\n }\n }\n }`,\n {\n variables: {\n \"id\": \"gid://shopify/Customer/544365967\",\n \"tags\": [\n \"Bob\"\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 removeTags($id: ID!, $tags: [String!]!) {\n tagsRemove(id: $id, tags: $tags) {\n node {\n id\n }\n userErrors {\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"id\": \"gid://shopify/Customer/544365967\",\n \"tags\": [\"Bob\"]\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 removeTags($id: ID!, $tags: [String!]!) {\n tagsRemove(id: $id, tags: $tags) {\n node {\n id\n }\n userErrors {\n message\n }\n }\n }`,\n \"variables\": {\n \"id\": \"gid://shopify/Customer/544365967\",\n \"tags\": [\n \"Bob\"\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 removeTags($id: ID!, $tags: [String!]!) {\n tagsRemove(id: $id, tags: $tags) {\n node {\n id\n }\n userErrors {\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"id\" => \"gid://shopify/Customer/544365967\",\n \"tags\" => [\"Bob\"],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "id",
"description": "The ID of the resource to remove tags from.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "id",
"argValue": " \"gid://shopify/Customer/544365967\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "tags",
"description": "A list of tags to remove from the resource in the form of an array of strings. Example value: `[\"tag1\", \"tag2\", \"tag3\"]`.",
"type": {
"kind": "SCALAR",
"name": "String",
"list": true,
"non_null": true
},
"defaultValue": null,
"typeSignature": "[String!]!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "tags",
"argValue": " [\"Bob\"]",
"typeKind": "MUTATION"
}
]
}
]