Choose a version:

Anchor to marketingActivityUpdateExternal

marketingActivityUpdateExternal

mutation

Requires write_marketing_events access scope.

Update an external marketing activity.

Anchor to Arguments

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: A custom unique identifier for the marketing activity, which can be used to manage the activity and send engagement metrics without having to store our marketing activity ID in your systems. 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?

Examples

Update an external marketing activity and its status

Description

Starting from API version 2024-01, the status field for creating an external marketing activity will be an optional, modifiable field.

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"
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-07/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"
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  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 json = await response.json();
  return json.data;
}

Ruby

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)

Node.js

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"
        }
    },
  },
});

Response

{
  "marketingActivityUpdateExternal": {
    "marketingActivity": {
      "id": "gid://shopify/MarketingActivity/36187062",
      "title": "New Title",
      "marketingEvent": {
        "manageUrl": "https://example.com",
        "previewUrl": "https://example.com"
      }
    }
  }
}

Update an external marketing activity using the remote id

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"
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-07/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"
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  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"
        }
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

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"
  }
}

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

Node.js

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"
        }
    },
  },
});

Response

{
  "marketingActivityUpdateExternal": {
    "marketingActivity": {
      "id": "gid://shopify/MarketingActivity/36187062",
      "title": "New Title",
      "marketingEvent": {
        "manageUrl": "https://example.com",
        "previewUrl": "https://example.com"
      }
    }
  }
}

Update an external marketing activity using the utm parameters

Query

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

Variables

{
  "utm": {
    "source": "email",
    "medium": "newsletter",
    "campaign": "external-event-campaign"
  },
  "updateInput": {
    "title": "New Title",
    "remoteUrl": "https://example.com",
    "remotePreviewImageUrl": "https://example.com"
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-07/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation marketingActivityUpdateExternal($utm: UTMInput!, $updateInput: MarketingActivityUpdateExternalInput!) { marketingActivityUpdateExternal(utm: $utm, input: $updateInput) { marketingActivity { id title marketingEvent { manageUrl previewUrl } } } }",
 "variables": {
    "utm": {
      "source": "email",
      "medium": "newsletter",
      "campaign": "external-event-campaign"
    },
    "updateInput": {
      "title": "New Title",
      "remoteUrl": "https://example.com",
      "remotePreviewImageUrl": "https://example.com"
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation marketingActivityUpdateExternal($utm: UTMInput!, $updateInput: MarketingActivityUpdateExternalInput!) {
    marketingActivityUpdateExternal(utm: $utm, input: $updateInput) {
      marketingActivity {
        id
        title
        marketingEvent {
          manageUrl
          previewUrl
        }
      }
    }
  }`,
  {
    variables: {
        "utm": {
            "source": "email",
            "medium": "newsletter",
            "campaign": "external-event-campaign"
        },
        "updateInput": {
            "title": "New Title",
            "remoteUrl": "https://example.com",
            "remotePreviewImageUrl": "https://example.com"
        }
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

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

variables = {
  "utm": {
    "source": "email",
    "medium": "newsletter",
    "campaign": "external-event-campaign"
  },
  "updateInput": {
    "title": "New Title",
    "remoteUrl": "https://example.com",
    "remotePreviewImageUrl": "https://example.com"
  }
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation marketingActivityUpdateExternal($utm: UTMInput!, $updateInput: MarketingActivityUpdateExternalInput!) {
      marketingActivityUpdateExternal(utm: $utm, input: $updateInput) {
        marketingActivity {
          id
          title
          marketingEvent {
            manageUrl
            previewUrl
          }
        }
      }
    }`,
    "variables": {
        "utm": {
            "source": "email",
            "medium": "newsletter",
            "campaign": "external-event-campaign"
        },
        "updateInput": {
            "title": "New Title",
            "remoteUrl": "https://example.com",
            "remotePreviewImageUrl": "https://example.com"
        }
    },
  },
});

Response

{
  "marketingActivityUpdateExternal": {
    "marketingActivity": {
      "id": "gid://shopify/MarketingActivity/36187062",
      "title": "New Title",
      "marketingEvent": {
        "manageUrl": "https://example.com",
        "previewUrl": "https://example.com"
      }
    }
  }
}

Updates a marketing event

Query

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

Variables

{
  "marketingActivityId": "gid://shopify/MarketingActivity/36187062",
  "updateInput": {
    "title": "New Title",
    "remoteUrl": "https://example.com",
    "remotePreviewImageUrl": "https://example.com"
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-07/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation marketingActivityUpdateExternal($marketingActivityId: ID!, $updateInput: MarketingActivityUpdateExternalInput!) { marketingActivityUpdateExternal(marketingActivityId: $marketingActivityId, input: $updateInput) { marketingActivity { id title marketingEvent { manageUrl previewUrl } } } }",
 "variables": {
    "marketingActivityId": "gid://shopify/MarketingActivity/36187062",
    "updateInput": {
      "title": "New Title",
      "remoteUrl": "https://example.com",
      "remotePreviewImageUrl": "https://example.com"
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation marketingActivityUpdateExternal($marketingActivityId: ID!, $updateInput: MarketingActivityUpdateExternalInput!) {
    marketingActivityUpdateExternal(marketingActivityId: $marketingActivityId, input: $updateInput) {
      marketingActivity {
        id
        title
        marketingEvent {
          manageUrl
          previewUrl
        }
      }
    }
  }`,
  {
    variables: {
        "marketingActivityId": "gid://shopify/MarketingActivity/36187062",
        "updateInput": {
            "title": "New Title",
            "remoteUrl": "https://example.com",
            "remotePreviewImageUrl": "https://example.com"
        }
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

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

variables = {
  "marketingActivityId": "gid://shopify/MarketingActivity/36187062",
  "updateInput": {
    "title": "New Title",
    "remoteUrl": "https://example.com",
    "remotePreviewImageUrl": "https://example.com"
  }
}

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

Node.js

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

Response

{
  "marketingActivityUpdateExternal": {
    "marketingActivity": {
      "id": "gid://shopify/MarketingActivity/36187062",
      "title": "New Title",
      "marketingEvent": {
        "manageUrl": "https://example.com",
        "previewUrl": "https://example.com"
      }
    }
  }
}

marketingActivityUpdateExternal reference

Examples

Open in GraphiQL

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

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

const response = await admin.graphql(

`#graphql

mutation marketingActivityUpdateExternal($remoteId: String!, $updateInput: MarketingActivityUpdateExternalInput!) {

marketingActivityUpdateExternal(remoteId: $remoteId, input: $updateInput) {

marketingActivity {

title

marketingEvent {

manageUrl

previewUrl

}

}`,

{

variables: {

"remoteId": "abcdefg",

"updateInput": {

"title": "New Title",

"remoteUrl": "https://example.com",

"remotePreviewImageUrl": "https://example.com",

"status": "PAUSED"

}

);

const json = await response.json();

return json.data;

}

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/2025-07/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"
    }
  }
}'

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  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 json = await response.json();
  return json.data;
}

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

{

"remoteId": "abcdefg",

"updateInput": {

"title": "New Title",

"remoteUrl": "https://example.com",

"remotePreviewImageUrl": "https://example.com",

"status": "PAUSED"

}

Response

JSON

{

"marketingActivityUpdateExternal": {

"marketingActivity": {

"id": "gid://shopify/MarketingActivity/36187062",

"title": "New Title",

"marketingEvent": {

"manageUrl": "https://example.com",

"previewUrl": "https://example.com"

}