commentApprove

mutation

Code examples for MUTATION: commentApprove

Query Reference for MUTATION: commentApprove

"mutation commentApprove($id: ID!) {\n  commentApprove(id: $id) {\n    comment {\n      # Comment fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: commentApprove

"{\n  \"id\": \"gid://shopify/<objectName>/10079785100\"\n}"

Schema Reference for MUTATION: commentApprove

""

Display Examples for MUTATION: commentApprove

[
  {
    "example": {
      "type_name": "commentapprove",
      "title": "Approving a comment with proper permissions",
      "description": "Approving a comment with the necessary merchant and user access scopes succeeds and publishes the comment",
      "query_string": "mutation ApproveComment($id: ID!) {\n  commentApprove(id: $id) {\n    comment {\n      id\n      status\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}",
      "variables": {
        "id": "gid://shopify/Comment/757536350"
      },
      "response": {
        "data": {
          "commentApprove": {
            "comment": {
              "id": "gid://shopify/Comment/757536350",
              "status": "PUBLISHED"
            },
            "userErrors": []
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "unstable",
      "maximum_api_version": "unstable",
      "location": "/components/online_store/test/unit/graph_api/admin/mutations/comment_approve_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 ApproveComment($id: ID!) { commentApprove(id: $id) { comment { id status } userErrors { field message } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/Comment/757536350\"\n  }\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation ApproveComment($id: ID!) {\n    commentApprove(id: $id) {\n      comment {\n        id\n        status\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/Comment/757536350\"\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 ApproveComment($id: ID!) {\n    commentApprove(id: $id) {\n      comment {\n        id\n        status\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/Comment/757536350\"\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 ApproveComment($id: ID!) {\n      commentApprove(id: $id) {\n        comment {\n          id\n          status\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/Comment/757536350\"\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 ApproveComment($id: ID!) {\n    commentApprove(id: $id) {\n      comment {\n        id\n        status\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/Comment/757536350\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
    },
    "titleStringKey": "variables",
    "inputVariableEntries": [
      {
        "arg": {
          "name": "id",
          "description": "The ID of the comment to be approved.",
          "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/Comment/757536350\"",
        "typeKind": "MUTATION"
      }
    ]
  },
  {
    "example": {
      "type_name": "commentapprove",
      "title": "Attempting to approve a comment without sufficient permissions",
      "description": "Trying to approve a comment without the necessary `write_content`access scope results in an access denied error",
      "query_string": "mutation ApproveComment($id: ID!) {\n  commentApprove(id: $id) {\n    comment {\n      id\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}",
      "variables": {
        "id": "gid://shopify/Comment/757536350"
      },
      "response": {
        "errors": [
          {
            "message": "Access denied for commentApprove field. Required access: Any of `write_content`, `write_online_store_pages` access scopes.",
            "locations": [
              {
                "line": 2,
                "column": 3
              }
            ],
            "path": [
              "commentApprove"
            ],
            "extensions": {
              "code": "ACCESS_DENIED",
              "documentation": "https://shopify.dev/api/usage/access-scopes",
              "requiredAccess": "Any of `write_content`, `write_online_store_pages` access scopes."
            }
          }
        ],
        "data": {
          "commentApprove": null
        }
      },
      "api_name": "admin",
      "minimum_api_version": "unstable",
      "maximum_api_version": "unstable",
      "location": "/components/online_store/test/unit/graph_api/admin/mutations/comment_approve_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 ApproveComment($id: ID!) { commentApprove(id: $id) { comment { id } userErrors { field message } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/Comment/757536350\"\n  }\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation ApproveComment($id: ID!) {\n    commentApprove(id: $id) {\n      comment {\n        id\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/Comment/757536350\"\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 ApproveComment($id: ID!) {\n    commentApprove(id: $id) {\n      comment {\n        id\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/Comment/757536350\"\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 ApproveComment($id: ID!) {\n      commentApprove(id: $id) {\n        comment {\n          id\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/Comment/757536350\"\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 ApproveComment($id: ID!) {\n    commentApprove(id: $id) {\n      comment {\n        id\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/Comment/757536350\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
    },
    "titleStringKey": "variables",
    "inputVariableEntries": [
      {
        "arg": {
          "name": "id",
          "description": "The ID of the comment to be approved.",
          "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/Comment/757536350\"",
        "typeKind": "MUTATION"
      }
    ]
  }
]