commentDelete

mutation

Requires Any of write_content, write_online_store_pages access scopes.

Deletes a comment.

Arguments

Anchor to idid • ID!required: The ID of the comment to be deleted.

Was this section helpful?

Anchor to CommentDeletePayload returnsCommentDeletePayload returns

Anchor to deletedCommentIddeletedCommentId • ID: The ID of the comment that was deleted.
Anchor to userErrorsuserErrors • [CommentDeleteUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Attempting to delete a non-existent comment
Deleting a comment with proper permissions
Failing to delete a comment due to missing access scopes
Removes a comment
commentDelete reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation DeleteComment($id: ID!) {
6    commentDelete(id: $id) {
7      deletedCommentId
8      userErrors {
9        field
10        message
11      }
12    }
13  }`,
14  {
15    variables: {
16      "id": "gid://shopify/Comment/9001"
17    },
18  },
19);
20
21const data = await response.json();
22

mutation DeleteComment($id: ID!) {
  commentDelete(id: $id) {
    deletedCommentId
    userErrors {
      field
      message
    }
  }
}

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 DeleteComment($id: ID!) { commentDelete(id: $id) { deletedCommentId userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/Comment/9001"
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation DeleteComment($id: ID!) {
    commentDelete(id: $id) {
      deletedCommentId
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/Comment/9001"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation DeleteComment($id: ID!) {
      commentDelete(id: $id) {
        deletedCommentId
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/Comment/9001"
    },
  },
});

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 DeleteComment($id: ID!) {
    commentDelete(id: $id) {
      deletedCommentId
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/Comment/9001"
}

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

Input variables

JSON

1{
2  "id": "gid://shopify/Comment/9001"
3}

Response

JSON

1{
2  "commentDelete": {
3    "deletedCommentId": null,
4    "userErrors": [
5      {
6        "field": [
7          "id"
8        ],
9        "message": "Comment does not exist"
10      }
11    ]
12  }
13}