Choose a version:

marketingActivityUpdate

mutation

Requires write_marketing_events access scope.

Updates a marketing activity with the latest information. Marketing activity app extensions are deprecated and will be removed in the near future.

Anchor to Arguments

Arguments

Anchor to inputinput •MarketingActivityUpdateInput! required: The Input of the marketing activity.

Was this section helpful?

Anchor to MarketingActivityUpdatePayload returnsMarketingActivityUpdatePayload returns

Anchor to marketingActivitymarketingActivity •MarketingActivity: The updated marketing activity.
Anchor to redirectPathredirectPath •String: The redirect path from the embedded editor to the Shopify admin.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Sets the budget for the marketing activity

Query

mutation marketingActivityUpdate($id: ID!, $budgetType: MarketingBudgetBudgetType!, $amount: Decimal!, $currencyCode: CurrencyCode!) {
  marketingActivityUpdate(input: {id: $id, budget: {budgetType: $budgetType, total: {amount: $amount, currencyCode: $currencyCode}}}) {
    marketingActivity {
      budget {
        budgetType
        total {
          amount
          currencyCode
        }
      }
    }
  }
}

Variables

{
  "id": "gid://shopify/MarketingActivity/794355127",
  "budgetType": "LIFETIME",
  "amount": 100,
  "currencyCode": "CAD"
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation marketingActivityUpdate($id: ID!, $budgetType: MarketingBudgetBudgetType!, $amount: Decimal!, $currencyCode: CurrencyCode!) { marketingActivityUpdate(input: {id: $id, budget: {budgetType: $budgetType, total: {amount: $amount, currencyCode: $currencyCode}}}) { marketingActivity { budget { budgetType total { amount currencyCode } } } } }",
 "variables": {
    "id": "gid://shopify/MarketingActivity/794355127",
    "budgetType": "LIFETIME",
    "amount": 100,
    "currencyCode": "CAD"
  }
}'

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 marketingActivityUpdate($id: ID!, $budgetType: MarketingBudgetBudgetType!, $amount: Decimal!, $currencyCode: CurrencyCode!) {
    marketingActivityUpdate(input: {id: $id, budget: {budgetType: $budgetType, total: {amount: $amount, currencyCode: $currencyCode}}}) {
      marketingActivity {
        budget {
          budgetType
          total {
            amount
            currencyCode
          }
        }
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/MarketingActivity/794355127",
        "budgetType": "LIFETIME",
        "amount": 100,
        "currencyCode": "CAD"
    },
  },
  );
  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 marketingActivityUpdate($id: ID!, $budgetType: MarketingBudgetBudgetType!, $amount: Decimal!, $currencyCode: CurrencyCode!) {
    marketingActivityUpdate(input: {id: $id, budget: {budgetType: $budgetType, total: {amount: $amount, currencyCode: $currencyCode}}}) {
      marketingActivity {
        budget {
          budgetType
          total {
            amount
            currencyCode
          }
        }
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/MarketingActivity/794355127",
  "budgetType": "LIFETIME",
  "amount": 100,
  "currencyCode": "CAD"
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation marketingActivityUpdate($id: ID!, $budgetType: MarketingBudgetBudgetType!, $amount: Decimal!, $currencyCode: CurrencyCode!) {
      marketingActivityUpdate(input: {id: $id, budget: {budgetType: $budgetType, total: {amount: $amount, currencyCode: $currencyCode}}}) {
        marketingActivity {
          budget {
            budgetType
            total {
              amount
              currencyCode
            }
          }
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/MarketingActivity/794355127",
        "budgetType": "LIFETIME",
        "amount": 100,
        "currencyCode": "CAD"
    },
  },
});

Response

{
  "marketingActivityUpdate": {
    "marketingActivity": {
      "budget": {
        "budgetType": "LIFETIME",
        "total": {
          "amount": "100.0",
          "currencyCode": "CAD"
        }
      }
    }
  }
}

Updates a marketing activity into ACTIVE state

Query

mutation marketingActivityUpdate($id: ID!, $status: MarketingActivityStatus!) {
  marketingActivityUpdate(input: {id: $id, status: $status}) {
    marketingActivity {
      id
      title
      status
    }
  }
}

Variables

{
  "id": "gid://shopify/MarketingActivity/794355127",
  "status": "ACTIVE"
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation marketingActivityUpdate($id: ID!, $status: MarketingActivityStatus!) { marketingActivityUpdate(input: {id: $id, status: $status}) { marketingActivity { id title status } } }",
 "variables": {
    "id": "gid://shopify/MarketingActivity/794355127",
    "status": "ACTIVE"
  }
}'

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 marketingActivityUpdate($id: ID!, $status: MarketingActivityStatus!) {
    marketingActivityUpdate(input: {id: $id, status: $status}) {
      marketingActivity {
        id
        title
        status
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/MarketingActivity/794355127",
        "status": "ACTIVE"
    },
  },
  );
  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 marketingActivityUpdate($id: ID!, $status: MarketingActivityStatus!) {
    marketingActivityUpdate(input: {id: $id, status: $status}) {
      marketingActivity {
        id
        title
        status
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/MarketingActivity/794355127",
  "status": "ACTIVE"
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation marketingActivityUpdate($id: ID!, $status: MarketingActivityStatus!) {
      marketingActivityUpdate(input: {id: $id, status: $status}) {
        marketingActivity {
          id
          title
          status
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/MarketingActivity/794355127",
        "status": "ACTIVE"
    },
  },
});

Response

{
  "marketingActivityUpdate": {
    "marketingActivity": {
      "id": "gid://shopify/MarketingActivity/794355127",
      "title": "Marketing Activity for Snowdevil",
      "status": "ACTIVE"
    }
  }
}

marketingActivityUpdate 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 marketingActivityUpdate($id: ID!, $budgetType: MarketingBudgetBudgetType!, $amount: Decimal!, $currencyCode: CurrencyCode!) {

marketingActivityUpdate(input: {id: $id, budget: {budgetType: $budgetType, total: {amount: $amount, currencyCode: $currencyCode}}}) {

marketingActivity {

budget {

budgetType

total {

amount

currencyCode

}

}`,

{

variables: {

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

"budgetType": "LIFETIME",

"amount": 100,

"currencyCode": "CAD"

);

const json = await response.json();

return json.data;

}

mutation marketingActivityUpdate($id: ID!, $budgetType: MarketingBudgetBudgetType!, $amount: Decimal!, $currencyCode: CurrencyCode!) {
  marketingActivityUpdate(input: {id: $id, budget: {budgetType: $budgetType, total: {amount: $amount, currencyCode: $currencyCode}}}) {
    marketingActivity {
      budget {
        budgetType
        total {
          amount
          currencyCode
        }
      }
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation marketingActivityUpdate($id: ID!, $budgetType: MarketingBudgetBudgetType!, $amount: Decimal!, $currencyCode: CurrencyCode!) { marketingActivityUpdate(input: {id: $id, budget: {budgetType: $budgetType, total: {amount: $amount, currencyCode: $currencyCode}}}) { marketingActivity { budget { budgetType total { amount currencyCode } } } } }",
 "variables": {
    "id": "gid://shopify/MarketingActivity/794355127",
    "budgetType": "LIFETIME",
    "amount": 100,
    "currencyCode": "CAD"
  }
}'

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

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation marketingActivityUpdate($id: ID!, $budgetType: MarketingBudgetBudgetType!, $amount: Decimal!, $currencyCode: CurrencyCode!) {
    marketingActivityUpdate(input: {id: $id, budget: {budgetType: $budgetType, total: {amount: $amount, currencyCode: $currencyCode}}}) {
      marketingActivity {
        budget {
          budgetType
          total {
            amount
            currencyCode
          }
        }
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/MarketingActivity/794355127",
        "budgetType": "LIFETIME",
        "amount": 100,
        "currencyCode": "CAD"
    },
  },
  );
  const json = await response.json();
  return json.data;
}

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation marketingActivityUpdate($id: ID!, $budgetType: MarketingBudgetBudgetType!, $amount: Decimal!, $currencyCode: CurrencyCode!) {
      marketingActivityUpdate(input: {id: $id, budget: {budgetType: $budgetType, total: {amount: $amount, currencyCode: $currencyCode}}}) {
        marketingActivity {
          budget {
            budgetType
            total {
              amount
              currencyCode
            }
          }
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/MarketingActivity/794355127",
        "budgetType": "LIFETIME",
        "amount": 100,
        "currencyCode": "CAD"
    },
  },
});

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 marketingActivityUpdate($id: ID!, $budgetType: MarketingBudgetBudgetType!, $amount: Decimal!, $currencyCode: CurrencyCode!) {
    marketingActivityUpdate(input: {id: $id, budget: {budgetType: $budgetType, total: {amount: $amount, currencyCode: $currencyCode}}}) {
      marketingActivity {
        budget {
          budgetType
          total {
            amount
            currencyCode
          }
        }
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/MarketingActivity/794355127",
  "budgetType": "LIFETIME",
  "amount": 100,
  "currencyCode": "CAD"
}

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

Input variables

JSON

{

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

"budgetType": "LIFETIME",

"amount": 100,

"currencyCode": "CAD"

}

Response

JSON

{

"marketingActivityUpdate": {

"marketingActivity": {

"budget": {

"budgetType": "LIFETIME",

"total": {

"amount": "100.0",

"currencyCode": "CAD"

}