Anchor to marketingActivityUpdatemarketing
marketingActivityUpdate
mutation
Requires access scope.
Updates a marketing activity with the latest information.
Anchor to Arguments
Arguments
- Anchor to inputinput•Marketing
Activity requiredUpdate Input! The Input of the marketing activity.
Was this section helpful?
Anchor to MarketingActivityUpdatePayload returnsMarketingActivityUpdatePayload returns
- Anchor to marketingActivitymarketing•
Activity The updated marketing activity.
- Anchor to redirectPathredirect•
Path The redirect path from the embedded editor to the Shopify admin.
- Anchor to userErrorsuser•
Errors [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
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,
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-01/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{
"id": "gid://shopify/MarketingActivity/794355127",
"budgetType": "LIFETIME",
"amount": 100,
"currencyCode": "CAD"
}
Response
JSON{
"marketingActivityUpdate": {
"marketingActivity": {
"budget": {
"budgetType": "LIFETIME",
"total": {
"amount": "100.0",
"currencyCode": "CAD"
}
}
}
}
}