articleDelete

mutation

Requires Any of write_content, write_online_store_pages access scopes.

Deletes an article.

Arguments

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

Was this section helpful?

Anchor to ArticleDeletePayload returnsArticleDeletePayload returns

Anchor to deletedArticleIddeletedArticleId • ID: The ID of the deleted article.
Anchor to userErrorsuserErrors • [ArticleDeleteUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Deletes an article
articleDelete reference

Examples

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

const response = await admin.graphql(

`#graphql

mutation DeleteArticle($id: ID!) {

articleDelete(id: $id) {

deletedArticleId

userErrors {

code

field

message

}

}`,

{

variables: {

"id": "gid://shopify/Article/959752435"

);

const data = await response.json();

mutation DeleteArticle($id: ID!) {
  articleDelete(id: $id) {
    deletedArticleId
    userErrors {
      code
      field
      message
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation DeleteArticle($id: ID!) { articleDelete(id: $id) { deletedArticleId userErrors { code field message } } }",
 "variables": {
    "id": "gid://shopify/Article/959752435"
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation DeleteArticle($id: ID!) {
    articleDelete(id: $id) {
      deletedArticleId
      userErrors {
        code
        field
        message
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/Article/959752435"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation DeleteArticle($id: ID!) {
      articleDelete(id: $id) {
        deletedArticleId
        userErrors {
          code
          field
          message
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/Article/959752435"
    },
  },
});

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 DeleteArticle($id: ID!) {
    articleDelete(id: $id) {
      deletedArticleId
      userErrors {
        code
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/Article/959752435"
}

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

Input variables

JSON

{

"id": "gid://shopify/Article/959752435"

}

Response

JSON

{

"articleDelete": {

"deletedArticleId": "gid://shopify/Article/959752435",

"userErrors": []

}