marketingEngagementsDelete

mutation

Requires write_marketing_events access scope.

Marks channel-level engagement data such that it no longer appears in reports. Activity-level data cannot be deleted directly, instead the MarketingActivity itself should be deleted to hide it from reports.

Arguments

Anchor to channelHandlechannelHandle • String: The handle of the channel for which engagement data should be deleted.
Anchor to deleteEngagementsForAllChannelsdeleteEngagementsForAllChannels • BooleanDefault:false: When true, engagements for all channels that belong to the api client will be deleted.

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.

Was this section helpful?

Mark all channel level engagement data associated to the api client for deletion
Mark engagement data associated to a specific channel for deletion
marketingEngagementsDelete reference

Examples

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 data = await response.json();

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

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 data = await response.json();

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
      }
    }
  }`,
});

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)

Response

JSON

{

"marketingEngagementsDelete": {

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

"userErrors": []

}