marketingActivityUpdate

mutation

Requires write_marketing_events access scope.

Updates a marketing activity with the latest information.

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?

Sets the budget for the marketing activity
Updates a marketing activity into ACTIVE state
marketingActivityUpdate reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation marketingActivityUpdate($id: ID!, $budgetType: MarketingBudgetBudgetType!, $amount: Decimal!, $currencyCode: CurrencyCode!) {
6    marketingActivityUpdate(input: {id: $id, budget: {budgetType: $budgetType, total: {amount: $amount, currencyCode: $currencyCode}}}) {
7      marketingActivity {
8        budget {
9          budgetType
10          total {
11            amount
12            currencyCode
13          }
14        }
15      }
16    }
17  }`,
18  {
19    variables: {
20      "id": "gid://shopify/MarketingActivity/794355127",
21      "budgetType": "LIFETIME",
22      "amount": 100,
23      "currencyCode": "CAD"
24    },
25  },
26);
27
28const data = await response.json();
29

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/2024-10/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"
  }
}'

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 data = await response.json();

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

1{
2  "id": "gid://shopify/MarketingActivity/794355127",
3  "budgetType": "LIFETIME",
4  "amount": 100,
5  "currencyCode": "CAD"
6}

Response

JSON

1{
2  "marketingActivityUpdate": {
3    "marketingActivity": {
4      "budget": {
5        "budgetType": "LIFETIME",
6        "total": {
7          "amount": "100.0",
8          "currencyCode": "CAD"
9        }
10      }
11    }
12  }
13}