marketingActivityUpsertExternal

mutation

Requires write_marketing_events access scope.

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.

Arguments

Anchor to inputinput • MarketingActivityUpsertExternalInput!required: The input field for creating or updating an external marketing activity.

Was this section helpful?

Anchor to MarketingActivityUpsertExternalPayload returnsMarketingActivityUpsertExternalPayload returns

Anchor to marketingActivitymarketingActivity • MarketingActivity: The external marketing activity that was created or updated.
Anchor to userErrorsuserErrors • [MarketingActivityUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Upsert (create or update) an external marketing activity
marketingActivityUpsertExternal reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation marketingActivityUpsertExternal($input: MarketingActivityUpsertExternalInput!) {
6    marketingActivityUpsertExternal(input: $input) {
7      marketingActivity {
8        id
9      }
10    }
11  }`,
12  {
13    variables: {
14      "input": {
15        "remoteId": "A unique identifier",
16        "title": "New Title",
17        "remoteUrl": "https://example.com",
18        "status": "ACTIVE",
19        "utm": {
20          "source": "email",
21          "medium": "newsletter",
22          "campaign": "external-campaign"
23        },
24        "tactic": "NEWSLETTER",
25        "marketingChannelType": "EMAIL"
26      }
27    },
28  },
29);
30
31const data = await response.json();
32

mutation marketingActivityUpsertExternal($input: MarketingActivityUpsertExternalInput!) {
  marketingActivityUpsertExternal(input: $input) {
    marketingActivity {
      id
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation marketingActivityUpsertExternal($input: MarketingActivityUpsertExternalInput!) { marketingActivityUpsertExternal(input: $input) { marketingActivity { id } } }",
 "variables": {
    "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"
    }
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation marketingActivityUpsertExternal($input: MarketingActivityUpsertExternalInput!) {
    marketingActivityUpsertExternal(input: $input) {
      marketingActivity {
        id
      }
    }
  }`,
  {
    variables: {
      "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"
      }
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation marketingActivityUpsertExternal($input: MarketingActivityUpsertExternalInput!) {
      marketingActivityUpsertExternal(input: $input) {
        marketingActivity {
          id
        }
      }
    }`,
    "variables": {
      "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"
      }
    },
  },
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation marketingActivityUpsertExternal($input: MarketingActivityUpsertExternalInput!) {
    marketingActivityUpsertExternal(input: $input) {
      marketingActivity {
        id
      }
    }
  }
QUERY

variables = {
  "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 = client.query(query: query, variables: variables)

Input variables

JSON

1{
2  "input": {
3    "remoteId": "A unique identifier",
4    "title": "New Title",
5    "remoteUrl": "https://example.com",
6    "status": "ACTIVE",
7    "utm": {
8      "source": "email",
9      "medium": "newsletter",
10      "campaign": "external-campaign"
11    },
12    "tactic": "NEWSLETTER",
13    "marketingChannelType": "EMAIL"
14  }
15}

Response

JSON

1{
2  "marketingActivityUpsertExternal": {
3    "marketingActivity": {
4      "id": "gid://shopify/MarketingActivity/1063897336"
5    }
6  }
7}