Choose a version:

marketingEngagementsDelete

mutation

Requires write_marketing_events access scope.

Deprecated. Channel-level engagements are deprecated. Activity-level engagement data cannot be deleted directly; delete the MarketingActivity instead.

Marks engagement data for a channel so it no longer appears in reports. Activity-level data cannot be deleted directly; delete the MarketingActivity instead.

Anchor to Arguments

Arguments

Deprecated arguments

Anchor to channelHandlechannelHandle •String Deprecated
Anchor to deleteEngagementsForAllChannelsdeleteEngagementsForAllChannels •Boolean DeprecatedDefault:false

Was this section helpful?

Anchor to MarketingEngagementsDeletePayload returnsMarketingEngagementsDeletePayload returns

Anchor to resultresult •String: Informational message about the engagement data that has been marked for deletion.
Anchor to userErrorsuserErrors •[MarketingActivityUserError!]! non-null: The list of errors that occurred from executing the mutation.

Show fields

Was this section helpful?

Examples

Mark all channel level engagement data associated to the api client for deletion

Query

mutation M($channelHandle: String, $deleteEngagementsForAllChannels: Boolean) {
  marketingEngagementsDelete(channelHandle: $channelHandle, deleteEngagementsForAllChannels: $deleteEngagementsForAllChannels) {
    result
    userErrors {
      field
      message
    }
  }
}

cURL

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 M($channelHandle: String, $deleteEngagementsForAllChannels: Boolean) { marketingEngagementsDelete(channelHandle: $channelHandle, deleteEngagementsForAllChannels: $deleteEngagementsForAllChannels) { result userErrors { field message } } }"
}'

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 M($channelHandle: String, $deleteEngagementsForAllChannels: Boolean) {
    marketingEngagementsDelete(channelHandle: $channelHandle, deleteEngagementsForAllChannels: $deleteEngagementsForAllChannels) {
      result
      userErrors {
        field
        message
      }
    }
  }`,
  );
  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 M($channelHandle: String, $deleteEngagementsForAllChannels: Boolean) {
    marketingEngagementsDelete(channelHandle: $channelHandle, deleteEngagementsForAllChannels: $deleteEngagementsForAllChannels) {
      result
      userErrors {
        field
        message
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `mutation M($channelHandle: String, $deleteEngagementsForAllChannels: Boolean) {
    marketingEngagementsDelete(channelHandle: $channelHandle, deleteEngagementsForAllChannels: $deleteEngagementsForAllChannels) {
      result
      userErrors {
        field
        message
      }
    }
  }`,
});

Shopify CLI

shopify app execute \
--query \
'mutation M($channelHandle: String, $deleteEngagementsForAllChannels: Boolean) {
  marketingEngagementsDelete(channelHandle: $channelHandle, deleteEngagementsForAllChannels: $deleteEngagementsForAllChannels) {
    result
    userErrors {
      field
      message
    }
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation M($channelHandle: String, $deleteEngagementsForAllChannels: Boolean) {
        marketingEngagementsDelete(channelHandle: $channelHandle, deleteEngagementsForAllChannels: $deleteEngagementsForAllChannels) {
          result
          userErrors {
            field
            message
          }
        }
      }
    `,
  }),
});

const { data } = await response.json();
console.log(data);

Response

{
  "marketingEngagementsDelete": {
    "result": "Engagement data marked for deletion for 5 channel(s)",
    "userErrors": []
  }
}

Mark engagement data associated to a specific channel for deletion

Query

mutation M($channelHandle: String, $deleteEngagementsForAllChannels: Boolean) {
  marketingEngagementsDelete(channelHandle: $channelHandle, deleteEngagementsForAllChannels: $deleteEngagementsForAllChannels) {
    result
    userErrors {
      field
      message
    }
  }
}

cURL

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 M($channelHandle: String, $deleteEngagementsForAllChannels: Boolean) { marketingEngagementsDelete(channelHandle: $channelHandle, deleteEngagementsForAllChannels: $deleteEngagementsForAllChannels) { result userErrors { field message } } }"
}'

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 M($channelHandle: String, $deleteEngagementsForAllChannels: Boolean) {
    marketingEngagementsDelete(channelHandle: $channelHandle, deleteEngagementsForAllChannels: $deleteEngagementsForAllChannels) {
      result
      userErrors {
        field
        message
      }
    }
  }`,
  );
  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 M($channelHandle: String, $deleteEngagementsForAllChannels: Boolean) {
    marketingEngagementsDelete(channelHandle: $channelHandle, deleteEngagementsForAllChannels: $deleteEngagementsForAllChannels) {
      result
      userErrors {
        field
        message
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `mutation M($channelHandle: String, $deleteEngagementsForAllChannels: Boolean) {
    marketingEngagementsDelete(channelHandle: $channelHandle, deleteEngagementsForAllChannels: $deleteEngagementsForAllChannels) {
      result
      userErrors {
        field
        message
      }
    }
  }`,
});

Shopify CLI

shopify app execute \
--query \
'mutation M($channelHandle: String, $deleteEngagementsForAllChannels: Boolean) {
  marketingEngagementsDelete(channelHandle: $channelHandle, deleteEngagementsForAllChannels: $deleteEngagementsForAllChannels) {
    result
    userErrors {
      field
      message
    }
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation M($channelHandle: String, $deleteEngagementsForAllChannels: Boolean) {
        marketingEngagementsDelete(channelHandle: $channelHandle, deleteEngagementsForAllChannels: $deleteEngagementsForAllChannels) {
          result
          userErrors {
            field
            message
          }
        }
      }
    `,
  }),
});

const { data } = await response.json();
console.log(data);

Response

{
  "marketingEngagementsDelete": {
    "result": "Engagement data associated to channel handle 'my-channel-handle' marked for deletion",
    "userErrors": []
  }
}

marketingEngagementsDelete reference

Examples

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

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

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

const response = await admin.graphql(

`#graphql

mutation M($channelHandle: String, $deleteEngagementsForAllChannels: Boolean) {

marketingEngagementsDelete(channelHandle: $channelHandle, deleteEngagementsForAllChannels: $deleteEngagementsForAllChannels) {

result

userErrors {

field

message

}

}`,

);

const json = await response.json();

return json.data;

}

GQL

mutation M($channelHandle: String, $deleteEngagementsForAllChannels: Boolean) {
  marketingEngagementsDelete(channelHandle: $channelHandle, deleteEngagementsForAllChannels: $deleteEngagementsForAllChannels) {
    result
    userErrors {
      field
      message
    }
  }
}

cURL

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 M($channelHandle: String, $deleteEngagementsForAllChannels: Boolean) { marketingEngagementsDelete(channelHandle: $channelHandle, deleteEngagementsForAllChannels: $deleteEngagementsForAllChannels) { result userErrors { field message } } }"
}'

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 M($channelHandle: String, $deleteEngagementsForAllChannels: Boolean) {
    marketingEngagementsDelete(channelHandle: $channelHandle, deleteEngagementsForAllChannels: $deleteEngagementsForAllChannels) {
      result
      userErrors {
        field
        message
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `mutation M($channelHandle: String, $deleteEngagementsForAllChannels: Boolean) {
    marketingEngagementsDelete(channelHandle: $channelHandle, deleteEngagementsForAllChannels: $deleteEngagementsForAllChannels) {
      result
      userErrors {
        field
        message
      }
    }
  }`,
});

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 M($channelHandle: String, $deleteEngagementsForAllChannels: Boolean) {
    marketingEngagementsDelete(channelHandle: $channelHandle, deleteEngagementsForAllChannels: $deleteEngagementsForAllChannels) {
      result
      userErrors {
        field
        message
      }
    }
  }
QUERY

response = client.query(query: query)

Shopify CLI

shopify app execute \
--query \
'mutation M($channelHandle: String, $deleteEngagementsForAllChannels: Boolean) {
  marketingEngagementsDelete(channelHandle: $channelHandle, deleteEngagementsForAllChannels: $deleteEngagementsForAllChannels) {
    result
    userErrors {
      field
      message
    }
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation M($channelHandle: String, $deleteEngagementsForAllChannels: Boolean) {
        marketingEngagementsDelete(channelHandle: $channelHandle, deleteEngagementsForAllChannels: $deleteEngagementsForAllChannels) {
          result
          userErrors {
            field
            message
          }
        }
      }
    `,
  }),
});

const { data } = await response.json();
console.log(data);

Response

JSON

{

"marketingEngagementsDelete": {

"result": "Engagement data marked for deletion for 5 channel(s)",

"userErrors": []

}