marketingActivityUpdateExternal

mutation

Requires write_marketing_events access scope.

Update an external marketing activity.

Arguments

Anchor to inputinput • MarketingActivityUpdateExternalInput!required: The input field for updating an external marketing activity.
Anchor to marketingActivityIdmarketingActivityId • ID: The ID of the marketing activity. Specify either the marketing activity ID, remote ID, or UTM to update the marketing activity.
Anchor to remoteIdremoteId • String: The ID of an activity that's hosted outside of Shopify. Specify either the marketing activity ID, remote ID, or UTM to update the marketing activity.
Anchor to utmutm • UTMInput: Specifies the Urchin Traffic Module (UTM) parameters that are associated with a related marketing campaign. Specify either the marketing activity ID, remote ID, or UTM to update the marketing activity.

Was this section helpful?

Anchor to MarketingActivityUpdateExternalPayload returnsMarketingActivityUpdateExternalPayload returns

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

Was this section helpful?

Update an external marketing activity and its status
Update an external marketing activity using the remote id
Update an external marketing activity using the utm parameters
Updates a marketing event
marketingActivityUpdateExternal reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation marketingActivityUpdateExternal($remoteId: String!, $updateInput: MarketingActivityUpdateExternalInput!) {
6    marketingActivityUpdateExternal(remoteId: $remoteId, input: $updateInput) {
7      marketingActivity {
8        id
9        title
10        marketingEvent {
11          manageUrl
12          previewUrl
13        }
14      }
15    }
16  }`,
17  {
18    variables: {
19      "remoteId": "abcdefg",
20      "updateInput": {
21        "title": "New Title",
22        "remoteUrl": "https://example.com",
23        "remotePreviewImageUrl": "https://example.com",
24        "status": "PAUSED"
25      }
26    },
27  },
28);
29
30const data = await response.json();
31

mutation marketingActivityUpdateExternal($remoteId: String!, $updateInput: MarketingActivityUpdateExternalInput!) {
  marketingActivityUpdateExternal(remoteId: $remoteId, input: $updateInput) {
    marketingActivity {
      id
      title
      marketingEvent {
        manageUrl
        previewUrl
      }
    }
  }
}

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 marketingActivityUpdateExternal($remoteId: String!, $updateInput: MarketingActivityUpdateExternalInput!) { marketingActivityUpdateExternal(remoteId: $remoteId, input: $updateInput) { marketingActivity { id title marketingEvent { manageUrl previewUrl } } } }",
 "variables": {
    "remoteId": "abcdefg",
    "updateInput": {
      "title": "New Title",
      "remoteUrl": "https://example.com",
      "remotePreviewImageUrl": "https://example.com",
      "status": "PAUSED"
    }
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation marketingActivityUpdateExternal($remoteId: String!, $updateInput: MarketingActivityUpdateExternalInput!) {
    marketingActivityUpdateExternal(remoteId: $remoteId, input: $updateInput) {
      marketingActivity {
        id
        title
        marketingEvent {
          manageUrl
          previewUrl
        }
      }
    }
  }`,
  {
    variables: {
      "remoteId": "abcdefg",
      "updateInput": {
        "title": "New Title",
        "remoteUrl": "https://example.com",
        "remotePreviewImageUrl": "https://example.com",
        "status": "PAUSED"
      }
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation marketingActivityUpdateExternal($remoteId: String!, $updateInput: MarketingActivityUpdateExternalInput!) {
      marketingActivityUpdateExternal(remoteId: $remoteId, input: $updateInput) {
        marketingActivity {
          id
          title
          marketingEvent {
            manageUrl
            previewUrl
          }
        }
      }
    }`,
    "variables": {
      "remoteId": "abcdefg",
      "updateInput": {
        "title": "New Title",
        "remoteUrl": "https://example.com",
        "remotePreviewImageUrl": "https://example.com",
        "status": "PAUSED"
      }
    },
  },
});

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 marketingActivityUpdateExternal($remoteId: String!, $updateInput: MarketingActivityUpdateExternalInput!) {
    marketingActivityUpdateExternal(remoteId: $remoteId, input: $updateInput) {
      marketingActivity {
        id
        title
        marketingEvent {
          manageUrl
          previewUrl
        }
      }
    }
  }
QUERY

variables = {
  "remoteId": "abcdefg",
  "updateInput": {
    "title": "New Title",
    "remoteUrl": "https://example.com",
    "remotePreviewImageUrl": "https://example.com",
    "status": "PAUSED"
  }
}

response = client.query(query: query, variables: variables)

Input variables

JSON

1{
2  "remoteId": "abcdefg",
3  "updateInput": {
4    "title": "New Title",
5    "remoteUrl": "https://example.com",
6    "remotePreviewImageUrl": "https://example.com",
7    "status": "PAUSED"
8  }
9}

Response

JSON

1{
2  "marketingActivityUpdateExternal": {
3    "marketingActivity": {
4      "id": "gid://shopify/MarketingActivity/36187062",
5      "title": "New Title",
6      "marketingEvent": {
7        "manageUrl": "https://example.com",
8        "previewUrl": "https://example.com"
9      }
10    }
11  }
12}