marketingActivityUpsertExternal - admin-graphql - MUTATION

Version: 2024-10

Description:

Creates a new external marketing activity or updates an existing one. When optional fields are absent or null, associated information will be removed from an existing marketing activity.

Access Scopes

`write_marketing_events` access scope.

Arguments

• input: MarketingActivityUpsertExternalInput! - The input field for creating or updating an external marketing activity.

Returns

• marketingActivity: MarketingActivity The external marketing activity that was created or updated.
• userErrors: MarketingActivityUserError! The list of errors that occurred from executing the mutation.

Examples

• Upsert (create or update) an external marketing activity

          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 marketingActivityUpsertExternal($input: MarketingActivityUpsertExternalInput!) { marketingActivityUpsertExternal(input: $input) { marketingActivity { id } } }\",\n \"variables\": {\n    \"input\": {\n      \"remoteId\": \"A unique identifier\",\n      \"title\": \"New Title\",\n      \"remoteUrl\": \"https://example.com\",\n      \"status\": \"ACTIVE\",\n      \"utm\": {\n        \"source\": \"email\",\n        \"medium\": \"newsletter\",\n        \"campaign\": \"external-campaign\"\n      },\n      \"tactic\": \"NEWSLETTER\",\n      \"marketingChannelType\": \"EMAIL\"\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation marketingActivityUpsertExternal($input: MarketingActivityUpsertExternalInput!) {\n      marketingActivityUpsertExternal(input: $input) {\n        marketingActivity {\n          id\n        }\n      }\n    }`,\n    \"variables\": {\n      \"input\": {\n        \"remoteId\": \"A unique identifier\",\n        \"title\": \"New Title\",\n        \"remoteUrl\": \"https://example.com\",\n        \"status\": \"ACTIVE\",\n        \"utm\": {\n          \"source\": \"email\",\n          \"medium\": \"newsletter\",\n          \"campaign\": \"external-campaign\"\n        },\n        \"tactic\": \"NEWSLETTER\",\n        \"marketingChannelType\": \"EMAIL\"\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 marketingActivityUpsertExternal($input: MarketingActivityUpsertExternalInput!) {\n    marketingActivityUpsertExternal(input: $input) {\n      marketingActivity {\n        id\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"input\": {\n    \"remoteId\": \"A unique identifier\",\n    \"title\": \"New Title\",\n    \"remoteUrl\": \"https://example.com\",\n    \"status\": \"ACTIVE\",\n    \"utm\": {\n      \"source\": \"email\",\n      \"medium\": \"newsletter\",\n      \"campaign\": \"external-campaign\"\n    },\n    \"tactic\": \"NEWSLETTER\",\n    \"marketingChannelType\": \"EMAIL\"\n  }\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 = << [\n    \"remoteId\" => \"A unique identifier\",\n    \"title\" => \"New Title\",\n    \"remoteUrl\" => \"https://example.com\",\n    \"status\" => \"ACTIVE\",\n    \"utm\" => [\n      \"source\" => \"email\",\n      \"medium\" => \"newsletter\",\n      \"campaign\" => \"external-campaign\",\n    ],\n    \"tactic\" => \"NEWSLETTER\",\n    \"marketingChannelType\" => \"EMAIL\",\n  ],\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 marketingActivityUpsertExternal($input: MarketingActivityUpsertExternalInput!) {\n    marketingActivityUpsertExternal(input: $input) {\n      marketingActivity {\n        id\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"input\": {\n        \"remoteId\": \"A unique identifier\",\n        \"title\": \"New Title\",\n        \"remoteUrl\": \"https://example.com\",\n        \"status\": \"ACTIVE\",\n        \"utm\": {\n          \"source\": \"email\",\n          \"medium\": \"newsletter\",\n          \"campaign\": \"external-campaign\"\n        },\n        \"tactic\": \"NEWSLETTER\",\n        \"marketingChannelType\": \"EMAIL\"\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation marketingActivityUpsertExternal($input: MarketingActivityUpsertExternalInput!) {\n  marketingActivityUpsertExternal(input: $input) {\n    marketingActivity {\n      id\n    }\n  }\n}"
        

  input: {
    "input": {
      "remoteId": "A unique identifier",
      "title": "New Title",
      "remoteUrl": "https://example.com",
      "status": "ACTIVE",
      "utm": {
        "source": "email",
        "medium": "newsletter",
        "campaign": "external-campaign"
      },
      "tactic": "NEWSLETTER",
      "marketingChannelType": "EMAIL"
    }
  }

  response: {
    "data": {
      "marketingActivityUpsertExternal": {
        "marketingActivity": {
          "id": "gid://shopify/MarketingActivity/1063897336"
        }
      }
    }
  }