Anchor to section titled 'undefined'

marketingActivityUpdate
mutation

Requires write_marketing_events access scope.

Updates a marketing activity with the latest information.

Anchor to section titled 'Arguments'

Arguments

Anchor to input
input
MarketingActivityUpdateInput!
required

The Input of the marketing activity.

Was this section helpful?
Anchor to section titled 'MarketingActivityUpdatePayload returns'

MarketingActivityUpdatePayload returns

Anchor to MarketingActivityUpdatePayload.marketingActivity
marketingActivity
MarketingActivity

The updated marketing activity.

Anchor to MarketingActivityUpdatePayload.redirectPath
redirectPath
String

The redirect path from the embedded editor to the Shopify admin.

Anchor to MarketingActivityUpdatePayload.userErrors
userErrors
[UserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Hide code
Copy
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-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();

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)

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

use Shopify\Clients\Graphql;

$client = new Graphql("your-development-store.myshopify.com", $accessToken);
$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]);
Hide code
Input variables
Copy
{
  "id": "gid://shopify/MarketingActivity/794355127",
  "budgetType": "LIFETIME",
  "amount": 100,
  "currencyCode": "CAD"
}
Hide code
Response
JSON
{
  "marketingActivityUpdate": {
    "marketingActivity": {
      "budget": {
        "budgetType": "LIFETIME",
        "total": {
          "amount": "100.0",
          "currencyCode": "CAD"
        }
      }
    }
  }
}