Choose a version:

marketingActivityDeleteExternal

mutation

Requires write_marketing_events access scope.

Deletes an external marketing activity.

Arguments

Anchor to marketingActivityIdmarketingActivityId • ID: The ID of the marketing activity. A marketing activity ID or remote ID must be provided.
Anchor to remoteIdremoteId • String: A custom unique identifier for the marketing activity, which can be used to manage the activity and send engagement metrics without having to store our marketing activity ID in your systems. A marketing activity ID or remote ID must be provided.

Was this section helpful?

Anchor to MarketingActivityDeleteExternalPayload returnsMarketingActivityDeleteExternalPayload returns

Anchor to deletedMarketingActivityIddeletedMarketingActivityId • ID: The ID of the marketing activity that was deleted, if one was deleted.
Anchor to userErrorsuserErrors • [MarketingActivityUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Delete an external marketing activity using the remote ID
Deletes a marketing event
marketingActivityDeleteExternal reference

Examples

Open in GraphiQL

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

const response = await admin.graphql(

`#graphql

mutation marketingActivityUpdateExternal($remoteId: String!) {

marketingActivityDeleteExternal(remoteId: $remoteId) {

deletedMarketingActivityId

}

}`,

{

variables: {

"remoteId": "abcdefg"

);

const data = await response.json();

mutation marketingActivityUpdateExternal($remoteId: String!) {
  marketingActivityDeleteExternal(remoteId: $remoteId) {
    deletedMarketingActivityId
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation marketingActivityUpdateExternal($remoteId: String!) { marketingActivityDeleteExternal(remoteId: $remoteId) { deletedMarketingActivityId } }",
 "variables": {
    "remoteId": "abcdefg"
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation marketingActivityUpdateExternal($remoteId: String!) {
    marketingActivityDeleteExternal(remoteId: $remoteId) {
      deletedMarketingActivityId
    }
  }`,
  {
    variables: {
      "remoteId": "abcdefg"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation marketingActivityUpdateExternal($remoteId: String!) {
      marketingActivityDeleteExternal(remoteId: $remoteId) {
        deletedMarketingActivityId
      }
    }`,
    "variables": {
      "remoteId": "abcdefg"
    },
  },
});

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 marketingActivityUpdateExternal($remoteId: String!) {
    marketingActivityDeleteExternal(remoteId: $remoteId) {
      deletedMarketingActivityId
    }
  }
QUERY

variables = {
  "remoteId": "abcdefg"
}

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

Input variables

JSON

{

"remoteId": "abcdefg"

}

Response

JSON

{

"marketingActivityDeleteExternal": {

"deletedMarketingActivityId": "gid://shopify/MarketingActivity/36187062"

}