marketingActivityDeleteExternal - admin-graphql - MUTATION

Version: 2024-10

Description:

Deletes an external marketing activity.

Access Scopes

`write_marketing_events` access scope.

Arguments

• marketingActivityId: ID - The ID of the marketing activity. A marketing activity ID or remote ID must be provided.
• remoteId: String - The ID of an activity that's hosted outside of Shopify. A marketing activity ID or remote ID must be provided.

Returns

• deletedMarketingActivityId: ID The ID of the marketing activity that was deleted, if one was deleted.
• userErrors: MarketingActivityUserError! The list of errors that occurred from executing the mutation.

Examples

• Delete an external marketing activity using the marketing activity ID

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation marketingActivityDeleteExternal($marketingActivityId: ID!) { marketingActivityDeleteExternal(marketingActivityId: $marketingActivityId) { deletedMarketingActivityId } }\",\n \"variables\": {\n    \"marketingActivityId\": \"gid://shopify/MarketingActivity/36187062\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation marketingActivityDeleteExternal($marketingActivityId: ID!) {\n      marketingActivityDeleteExternal(marketingActivityId: $marketingActivityId) {\n        deletedMarketingActivityId\n      }\n    }`,\n    \"variables\": {\n      \"marketingActivityId\": \"gid://shopify/MarketingActivity/36187062\"\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation marketingActivityDeleteExternal($marketingActivityId: ID!) {\n    marketingActivityDeleteExternal(marketingActivityId: $marketingActivityId) {\n      deletedMarketingActivityId\n    }\n  }\nQUERY\n\nvariables = {\n  \"marketingActivityId\": \"gid://shopify/MarketingActivity/36187062\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = << \"gid://shopify/MarketingActivity/36187062\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation marketingActivityDeleteExternal($marketingActivityId: ID!) {\n    marketingActivityDeleteExternal(marketingActivityId: $marketingActivityId) {\n      deletedMarketingActivityId\n    }\n  }`,\n  {\n    variables: {\n      \"marketingActivityId\": \"gid://shopify/MarketingActivity/36187062\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation marketingActivityDeleteExternal($marketingActivityId: ID!) {\n  marketingActivityDeleteExternal(marketingActivityId: $marketingActivityId) {\n    deletedMarketingActivityId\n  }\n}"
        

  input: {
    "marketingActivityId": "gid://shopify/MarketingActivity/36187062"
  }

  response: {
    "data": {
      "marketingActivityDeleteExternal": {
        "deletedMarketingActivityId": "gid://shopify/MarketingActivity/36187062"
      }
    }
  }

  Delete an external marketing activity using the remote ID

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation marketingActivityUpdateExternal($remoteId: String!) { marketingActivityDeleteExternal(remoteId: $remoteId) { deletedMarketingActivityId } }\",\n \"variables\": {\n    \"remoteId\": \"abcdefg\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation marketingActivityUpdateExternal($remoteId: String!) {\n      marketingActivityDeleteExternal(remoteId: $remoteId) {\n        deletedMarketingActivityId\n      }\n    }`,\n    \"variables\": {\n      \"remoteId\": \"abcdefg\"\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation marketingActivityUpdateExternal($remoteId: String!) {\n    marketingActivityDeleteExternal(remoteId: $remoteId) {\n      deletedMarketingActivityId\n    }\n  }\nQUERY\n\nvariables = {\n  \"remoteId\": \"abcdefg\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = << \"abcdefg\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation marketingActivityUpdateExternal($remoteId: String!) {\n    marketingActivityDeleteExternal(remoteId: $remoteId) {\n      deletedMarketingActivityId\n    }\n  }`,\n  {\n    variables: {\n      \"remoteId\": \"abcdefg\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation marketingActivityUpdateExternal($remoteId: String!) {\n  marketingActivityDeleteExternal(remoteId: $remoteId) {\n    deletedMarketingActivityId\n  }\n}"
        

  input: {
    "remoteId": "abcdefg"
  }

  response: {
    "data": {
      "marketingActivityDeleteExternal": {
        "deletedMarketingActivityId": "gid://shopify/MarketingActivity/36187062"
      }
    }
  }