marketingActivityCreateExternal

mutation

Requires write_marketing_events access scope.

Creates a new external marketing activity.

Arguments

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

Was this section helpful?

Anchor to MarketingActivityCreateExternalPayload returnsMarketingActivityCreateExternalPayload returns

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

Was this section helpful?

Create an external marketing activity with a status
Creates a marketing event
marketingActivityCreateExternal reference

Examples

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

mutation marketingActivityCreateExternal($createInput: MarketingActivityCreateExternalInput!) {
  marketingActivityCreateExternal(input: $createInput) {
    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 marketingActivityCreateExternal($createInput: MarketingActivityCreateExternalInput!) { marketingActivityCreateExternal(input: $createInput) { marketingActivity { id } } }",
 "variables": {
    "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"
    }
  }
}'

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

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

const data = await response.json();

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

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 marketingActivityCreateExternal($createInput: MarketingActivityCreateExternalInput!) {
    marketingActivityCreateExternal(input: $createInput) {
      marketingActivity {
        id
      }
    }
  }
QUERY

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

Input variables

JSON

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

Response

JSON

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