marketingActivitiesDeleteAllExternal
mutation

Choose a version:

Requires write_marketing_events access scope.

Deletes all external marketing activities. Deletion is performed by a background job, as it may take a bit of time to complete if a large number of activities are to be deleted. Attempting to create or modify external activities before the job has completed will result in the create/update/upsert mutation returning an error.

Anchor to section titled 'MarketingActivitiesDeleteAllExternalPayload returns'

MarketingActivitiesDeleteAllExternalPayload returns

Anchor to MarketingActivitiesDeleteAllExternalPayload.job job Job: The asynchronous job that performs the deletion. The status of the job may be used to determine when it's safe again to create new activities.
Anchor to MarketingActivitiesDeleteAllExternalPayload.userErrors userErrors [MarketingActivityUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: marketingActivitiesDeleteAllExternal

Query Reference for MUTATION: marketingActivitiesDeleteAllExternal

"mutation marketingActivitiesDeleteAllExternal {\n  marketingActivitiesDeleteAllExternal {\n    job {\n      # Job fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: marketingActivitiesDeleteAllExternal

"{}"

Schema Reference for MUTATION: marketingActivitiesDeleteAllExternal

""

Display Examples for MUTATION: marketingActivitiesDeleteAllExternal

[
  {
    "example": {
      "type_name": "marketingactivitiesdeleteallexternal",
      "title": "Enqueues a job to delete all external activities",
      "query_string": "mutation marketingActivitiesDeleteAllExternal {\n  marketingActivitiesDeleteAllExternal {\n    job {\n      id\n    }\n  }\n}",
      "response": {
        "data": {
          "marketingActivitiesDeleteAllExternal": {
            "job": {
              "id": "gid://shopify/Job/d778213f-460c-467c-b35b-f040b7812c82"
            }
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2024-01",
      "maximum_api_version": "unstable",
      "location": "/components/merchant_marketing/test/unit/graph_api/admin/mutations/marketing_activities_delete_all_external_test.rb",
      "curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation marketingActivitiesDeleteAllExternal { marketingActivitiesDeleteAllExternal { job { id } } }\"\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation marketingActivitiesDeleteAllExternal {\n    marketingActivitiesDeleteAllExternal {\n      job {\n        id\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\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 marketingActivitiesDeleteAllExternal {\n    marketingActivitiesDeleteAllExternal {\n      job {\n        id\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n",
      "node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `mutation marketingActivitiesDeleteAllExternal {\n    marketingActivitiesDeleteAllExternal {\n      job {\n        id\n      }\n    }\n  }`,\n});\n",
      "php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation marketingActivitiesDeleteAllExternal {\n    marketingActivitiesDeleteAllExternal {\n      job {\n        id\n      }\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
    },
    "titleStringKey": "variables",
    "inputVariableEntries": []
  }
]

marketingActivitiesDeleteAllExternalmutation

MarketingActivitiesDeleteAllExternalPayload returns

marketingActivitiesDeleteAllExternal
mutation