Choose a version:

commentSpam

mutation

Requires Any of write_content, write_online_store_pages access scopes.

Marks a comment as spam, removing it from public view. This mutation enables merchants to quickly handle unwanted promotional content, malicious links, or other spam that appears in blog discussions.

For example, when a comment contains suspicious links to unrelated products or services, merchants can mark it as spam to immediately hide it from customers.

Use the commentSpam mutation to:

Hide promotional or malicious comments from public view
Protect customers from potentially harmful links
Maintain professional discussion quality on blog articles

Spam-marked comments can be reviewed later and potentially restored using the commentNotSpam mutation if they were incorrectly classified.

Anchor to Arguments

Arguments

Anchor to idid •ID! required: The ID of the comment to be marked as spam.

Was this section helpful?

Anchor to CommentSpamPayload returnsCommentSpamPayload returns

Anchor to commentcomment •Comment: The comment that was marked as spam.
Anchor to userErrorsuserErrors •[CommentSpamUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Marks a comment as spam

Description

Marks a comment as spam

Query

mutation MarkCommentAsSpam($id: ID!) {
  commentSpam(id: $id) {
    comment {
      id
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "id": "gid://shopify/Comment/757536350"
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation MarkCommentAsSpam($id: ID!) { commentSpam(id: $id) { comment { id } userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/Comment/757536350"
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation MarkCommentAsSpam($id: ID!) {
    commentSpam(id: $id) {
      comment {
        id
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/Comment/757536350"
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

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 MarkCommentAsSpam($id: ID!) {
    commentSpam(id: $id) {
      comment {
        id
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

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

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

Node.js

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

Response

{
  "commentSpam": {
    "comment": {
      "id": "gid://shopify/Comment/757536350"
    },
    "userErrors": []
  }
}

commentSpam reference

Examples

Open in GraphiQL

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

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

const response = await admin.graphql(

`#graphql

mutation MarkCommentAsSpam($id: ID!) {

commentSpam(id: $id) {

comment {

}

userErrors {

field

message

}

}`,

{

variables: {

"id": "gid://shopify/Comment/757536350"

);

const json = await response.json();

return json.data;

}

GQL

mutation MarkCommentAsSpam($id: ID!) {
  commentSpam(id: $id) {
    comment {
      id
    }
    userErrors {
      field
      message
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation MarkCommentAsSpam($id: ID!) { commentSpam(id: $id) { comment { id } userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/Comment/757536350"
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation MarkCommentAsSpam($id: ID!) {
    commentSpam(id: $id) {
      comment {
        id
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/Comment/757536350"
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Node.js

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

Ruby

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 MarkCommentAsSpam($id: ID!) {
    commentSpam(id: $id) {
      comment {
        id
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

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

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

Input variables

JSON

{

"id": "gid://shopify/Comment/757536350"

}

Response

JSON

{

"commentSpam": {

"comment": {

"id": "gid://shopify/Comment/757536350"

"userErrors": []

}