marketingActivityCreateExternal - admin-graphql - MUTATION

Version: 2024-10

Description:

Creates a new external marketing activity.

Access Scopes

`write_marketing_events` access scope.

Arguments

• input: MarketingActivityCreateExternalInput! - The input field for creating an external marketing activity.

Returns

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

Examples

• Create an external marketing activity with a status

          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 marketingActivityCreateExternal($createInput: MarketingActivityCreateExternalInput!) { marketingActivityCreateExternal(input: $createInput) { marketingActivity { id } } }\",\n \"variables\": {\n    \"createInput\": {\n      \"remoteId\": \"fake_id\",\n      \"title\": \"New Title\",\n      \"remoteUrl\": \"https://example.com\",\n      \"remotePreviewImageUrl\": \"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 marketingActivityCreateExternal($createInput: MarketingActivityCreateExternalInput!) {\n      marketingActivityCreateExternal(input: $createInput) {\n        marketingActivity {\n          id\n        }\n      }\n    }`,\n    \"variables\": {\n      \"createInput\": {\n        \"remoteId\": \"fake_id\",\n        \"title\": \"New Title\",\n        \"remoteUrl\": \"https://example.com\",\n        \"remotePreviewImageUrl\": \"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 marketingActivityCreateExternal($createInput: MarketingActivityCreateExternalInput!) {\n    marketingActivityCreateExternal(input: $createInput) {\n      marketingActivity {\n        id\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"createInput\": {\n    \"remoteId\": \"fake_id\",\n    \"title\": \"New Title\",\n    \"remoteUrl\": \"https://example.com\",\n    \"remotePreviewImageUrl\": \"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 = <<<QUERY\n  mutation marketingActivityCreateExternal($createInput: MarketingActivityCreateExternalInput!) {\n    marketingActivityCreateExternal(input: $createInput) {\n      marketingActivity {\n        id\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"createInput\" => [\n    \"remoteId\" => \"fake_id\",\n    \"title\" => \"New Title\",\n    \"remoteUrl\" => \"https://example.com\",\n    \"remotePreviewImageUrl\" => \"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 marketingActivityCreateExternal($createInput: MarketingActivityCreateExternalInput!) {\n    marketingActivityCreateExternal(input: $createInput) {\n      marketingActivity {\n        id\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"createInput\": {\n        \"remoteId\": \"fake_id\",\n        \"title\": \"New Title\",\n        \"remoteUrl\": \"https://example.com\",\n        \"remotePreviewImageUrl\": \"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 marketingActivityCreateExternal($createInput: MarketingActivityCreateExternalInput!) {\n  marketingActivityCreateExternal(input: $createInput) {\n    marketingActivity {\n      id\n    }\n  }\n}"
        

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

  response: {
    "data": {
      "marketingActivityCreateExternal": {
        "marketingActivity": {
          "id": "gid://shopify/MarketingActivity/1063897621"
        }
      }
    }
  }

  Creates a marketing event

          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 MarketingCreateEvent($input: MarketingActivityCreateExternalInput!) { marketingActivityCreateExternal(input: $input) { marketingActivity { id marketingEvent { id type startedAt utmCampaign utmMedium utmSource marketingChannelType } } } }\",\n \"variables\": {\n    \"input\": {\n      \"remoteId\": \"fake_id\",\n      \"title\": \"New Marketing Event\",\n      \"remoteUrl\": \"https://example.com\",\n      \"remotePreviewImageUrl\": \"https://example.com\",\n      \"utm\": {\n        \"source\": \"source\",\n        \"medium\": \"medium\",\n        \"campaign\": \"campaign\"\n      },\n      \"marketingChannelType\": \"SOCIAL\",\n      \"tactic\": \"POST\"\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation MarketingCreateEvent($input: MarketingActivityCreateExternalInput!) {\n      marketingActivityCreateExternal(input: $input) {\n        marketingActivity {\n          id\n          marketingEvent {\n            id\n            type\n            startedAt\n            utmCampaign\n            utmMedium\n            utmSource\n            marketingChannelType\n          }\n        }\n      }\n    }`,\n    \"variables\": {\n      \"input\": {\n        \"remoteId\": \"fake_id\",\n        \"title\": \"New Marketing Event\",\n        \"remoteUrl\": \"https://example.com\",\n        \"remotePreviewImageUrl\": \"https://example.com\",\n        \"utm\": {\n          \"source\": \"source\",\n          \"medium\": \"medium\",\n          \"campaign\": \"campaign\"\n        },\n        \"marketingChannelType\": \"SOCIAL\",\n        \"tactic\": \"POST\"\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 MarketingCreateEvent($input: MarketingActivityCreateExternalInput!) {\n    marketingActivityCreateExternal(input: $input) {\n      marketingActivity {\n        id\n        marketingEvent {\n          id\n          type\n          startedAt\n          utmCampaign\n          utmMedium\n          utmSource\n          marketingChannelType\n        }\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"input\": {\n    \"remoteId\": \"fake_id\",\n    \"title\": \"New Marketing Event\",\n    \"remoteUrl\": \"https://example.com\",\n    \"remotePreviewImageUrl\": \"https://example.com\",\n    \"utm\": {\n      \"source\": \"source\",\n      \"medium\": \"medium\",\n      \"campaign\": \"campaign\"\n    },\n    \"marketingChannelType\": \"SOCIAL\",\n    \"tactic\": \"POST\"\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 = <<<QUERY\n  mutation MarketingCreateEvent($input: MarketingActivityCreateExternalInput!) {\n    marketingActivityCreateExternal(input: $input) {\n      marketingActivity {\n        id\n        marketingEvent {\n          id\n          type\n          startedAt\n          utmCampaign\n          utmMedium\n          utmSource\n          marketingChannelType\n        }\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"input\" => [\n    \"remoteId\" => \"fake_id\",\n    \"title\" => \"New Marketing Event\",\n    \"remoteUrl\" => \"https://example.com\",\n    \"remotePreviewImageUrl\" => \"https://example.com\",\n    \"utm\" => [\n      \"source\" => \"source\",\n      \"medium\" => \"medium\",\n      \"campaign\" => \"campaign\",\n    ],\n    \"marketingChannelType\" => \"SOCIAL\",\n    \"tactic\" => \"POST\",\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 MarketingCreateEvent($input: MarketingActivityCreateExternalInput!) {\n    marketingActivityCreateExternal(input: $input) {\n      marketingActivity {\n        id\n        marketingEvent {\n          id\n          type\n          startedAt\n          utmCampaign\n          utmMedium\n          utmSource\n          marketingChannelType\n        }\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"input\": {\n        \"remoteId\": \"fake_id\",\n        \"title\": \"New Marketing Event\",\n        \"remoteUrl\": \"https://example.com\",\n        \"remotePreviewImageUrl\": \"https://example.com\",\n        \"utm\": {\n          \"source\": \"source\",\n          \"medium\": \"medium\",\n          \"campaign\": \"campaign\"\n        },\n        \"marketingChannelType\": \"SOCIAL\",\n        \"tactic\": \"POST\"\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation MarketingCreateEvent($input: MarketingActivityCreateExternalInput!) {\n  marketingActivityCreateExternal(input: $input) {\n    marketingActivity {\n      id\n      marketingEvent {\n        id\n        type\n        startedAt\n        utmCampaign\n        utmMedium\n        utmSource\n        marketingChannelType\n      }\n    }\n  }\n}"
        

  input: {
    "input": {
      "remoteId": "fake_id",
      "title": "New Marketing Event",
      "remoteUrl": "https://example.com",
      "remotePreviewImageUrl": "https://example.com",
      "utm": {
        "source": "source",
        "medium": "medium",
        "campaign": "campaign"
      },
      "marketingChannelType": "SOCIAL",
      "tactic": "POST"
    }
  }

  response: {
    "data": {
      "marketingActivityCreateExternal": {
        "marketingActivity": {
          "id": "gid://shopify/MarketingActivity/1063897614",
          "marketingEvent": {
            "id": "gid://shopify/MarketingEvent/1069064164",
            "type": "POST",
            "startedAt": "2024-11-18T22:43:21Z",
            "utmCampaign": "campaign",
            "utmMedium": "medium",
            "utmSource": "source",
            "marketingChannelType": "SOCIAL"
          }
        }
      }
    }
  }