marketingActivitiesDeleteAllExternal - admin-graphql - MUTATION

Version: 2024-04

Description:

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.

Access Scopes

`write_marketing_events` access scope.

Arguments

Returns

• 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.
• userErrors: MarketingActivityUserError! The list of errors that occurred from executing the mutation.

Examples

• Enqueues a job to delete all external activities

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/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"
          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"
          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"
          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"
          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"
          Graphql query: "mutation marketingActivitiesDeleteAllExternal {\n  marketingActivitiesDeleteAllExternal {\n    job {\n      id\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "marketingActivitiesDeleteAllExternal": {
        "job": {
          "id": "gid://shopify/Job/d778213f-460c-467c-b35b-f040b7812c82"
        }
      }
    }
  }