Anchor to section titled 'undefined'

marketingActivityDeleteExternal
mutation

Requires write_marketing_events access scope.

Deletes an external marketing activity.


The ID of the marketing activity. A marketing activity ID or remote ID must be provided.

The ID of an activity that's hosted outside of Shopify. A marketing activity ID or remote ID must be provided.


Was this section helpful?

The ID of the marketing activity that was deleted, if one was deleted.

The list of errors that occurred from executing the mutation.


Was this section helpful?

Examples

Hide code
Copy
mutation marketingActivityDeleteExternal($marketingActivityId: ID!) {
  marketingActivityDeleteExternal(marketingActivityId: $marketingActivityId) {
    deletedMarketingActivityId
  }
}
curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation marketingActivityDeleteExternal($marketingActivityId: ID!) { marketingActivityDeleteExternal(marketingActivityId: $marketingActivityId) { deletedMarketingActivityId } }",
 "variables": {
    "marketingActivityId": "gid://shopify/MarketingActivity/36187062"
  }
}'
const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation marketingActivityDeleteExternal($marketingActivityId: ID!) {
    marketingActivityDeleteExternal(marketingActivityId: $marketingActivityId) {
      deletedMarketingActivityId
    }
  }`,
  {
    variables: {
      "marketingActivityId": "gid://shopify/MarketingActivity/36187062"
    },
  },
);

const data = await response.json();
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 marketingActivityDeleteExternal($marketingActivityId: ID!) {
    marketingActivityDeleteExternal(marketingActivityId: $marketingActivityId) {
      deletedMarketingActivityId
    }
  }
QUERY

variables = {
  "marketingActivityId": "gid://shopify/MarketingActivity/36187062"
}

response = client.query(query: query, variables: variables)
const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation marketingActivityDeleteExternal($marketingActivityId: ID!) {
      marketingActivityDeleteExternal(marketingActivityId: $marketingActivityId) {
        deletedMarketingActivityId
      }
    }`,
    "variables": {
      "marketingActivityId": "gid://shopify/MarketingActivity/36187062"
    },
  },
});
use Shopify\Clients\Graphql;

$client = new Graphql("your-development-store.myshopify.com", $accessToken);
$query = <<<QUERY
  mutation marketingActivityDeleteExternal($marketingActivityId: ID!) {
    marketingActivityDeleteExternal(marketingActivityId: $marketingActivityId) {
      deletedMarketingActivityId
    }
  }
QUERY;

$variables = [
  "marketingActivityId" => "gid://shopify/MarketingActivity/36187062",
];

$response = $client->query(["query" => $query, "variables" => $variables]);
Hide code
Input variables
Copy
{
  "marketingActivityId": "gid://shopify/MarketingActivity/36187062"
}
Hide code
Response
JSON
{
  "marketingActivityDeleteExternal": {
    "deletedMarketingActivityId": "gid://shopify/MarketingActivity/36187062"
  }
}