marketingActivityUpdate - admin-graphql - MUTATION

Version: 2024-01

Description:

Updates a marketing activity with the latest information.

Access Scopes

`write_marketing_events` access scope.

Arguments

• input: MarketingActivityUpdateInput! - The Input of the marketing activity.

Returns

• marketingActivity: MarketingActivity The updated marketing activity.
• redirectPath: String The redirect path from the embedded editor to the Shopify admin.
• userErrors: UserError! The list of errors that occurred from executing the mutation.

Examples

• Sets the budget for the marketing activity

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"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 } } } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/MarketingActivity/794355127\",\n    \"budgetType\": \"LIFETIME\",\n    \"amount\": 100,\n    \"currencyCode\": \"CAD\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation marketingActivityUpdate($id: ID!, $budgetType: MarketingBudgetBudgetType!, $amount: Decimal!, $currencyCode: CurrencyCode!) {\n      marketingActivityUpdate(input: {id: $id, budget: {budgetType: $budgetType, total: {amount: $amount, currencyCode: $currencyCode}}}) {\n        marketingActivity {\n          budget {\n            budgetType\n            total {\n              amount\n              currencyCode\n            }\n          }\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/MarketingActivity/794355127\",\n      \"budgetType\": \"LIFETIME\",\n      \"amount\": 100,\n      \"currencyCode\": \"CAD\"\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation marketingActivityUpdate($id: ID!, $budgetType: MarketingBudgetBudgetType!, $amount: Decimal!, $currencyCode: CurrencyCode!) {\n    marketingActivityUpdate(input: {id: $id, budget: {budgetType: $budgetType, total: {amount: $amount, currencyCode: $currencyCode}}}) {\n      marketingActivity {\n        budget {\n          budgetType\n          total {\n            amount\n            currencyCode\n          }\n        }\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/MarketingActivity/794355127\",\n  \"budgetType\": \"LIFETIME\",\n  \"amount\": 100,\n  \"currencyCode\": \"CAD\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation marketingActivityUpdate($id: ID!, $budgetType: MarketingBudgetBudgetType!, $amount: Decimal!, $currencyCode: CurrencyCode!) {\n    marketingActivityUpdate(input: {id: $id, budget: {budgetType: $budgetType, total: {amount: $amount, currencyCode: $currencyCode}}}) {\n      marketingActivity {\n        budget {\n          budgetType\n          total {\n            amount\n            currencyCode\n          }\n        }\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/MarketingActivity/794355127\",\n  \"budgetType\" => \"LIFETIME\",\n  \"amount\" => 100,\n  \"currencyCode\" => \"CAD\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation marketingActivityUpdate($id: ID!, $budgetType: MarketingBudgetBudgetType!, $amount: Decimal!, $currencyCode: CurrencyCode!) {\n    marketingActivityUpdate(input: {id: $id, budget: {budgetType: $budgetType, total: {amount: $amount, currencyCode: $currencyCode}}}) {\n      marketingActivity {\n        budget {\n          budgetType\n          total {\n            amount\n            currencyCode\n          }\n        }\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/MarketingActivity/794355127\",\n      \"budgetType\": \"LIFETIME\",\n      \"amount\": 100,\n      \"currencyCode\": \"CAD\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation marketingActivityUpdate($id: ID!, $budgetType: MarketingBudgetBudgetType!, $amount: Decimal!, $currencyCode: CurrencyCode!) {\n  marketingActivityUpdate(input: {id: $id, budget: {budgetType: $budgetType, total: {amount: $amount, currencyCode: $currencyCode}}}) {\n    marketingActivity {\n      budget {\n        budgetType\n        total {\n          amount\n          currencyCode\n        }\n      }\n    }\n  }\n}"
        

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

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

  Updates a marketing activity into ACTIVE state

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation marketingActivityUpdate($id: ID!, $status: MarketingActivityStatus!) { marketingActivityUpdate(input: {id: $id, status: $status}) { marketingActivity { id title status } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/MarketingActivity/794355127\",\n    \"status\": \"ACTIVE\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation marketingActivityUpdate($id: ID!, $status: MarketingActivityStatus!) {\n      marketingActivityUpdate(input: {id: $id, status: $status}) {\n        marketingActivity {\n          id\n          title\n          status\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/MarketingActivity/794355127\",\n      \"status\": \"ACTIVE\"\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation marketingActivityUpdate($id: ID!, $status: MarketingActivityStatus!) {\n    marketingActivityUpdate(input: {id: $id, status: $status}) {\n      marketingActivity {\n        id\n        title\n        status\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/MarketingActivity/794355127\",\n  \"status\": \"ACTIVE\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation marketingActivityUpdate($id: ID!, $status: MarketingActivityStatus!) {\n    marketingActivityUpdate(input: {id: $id, status: $status}) {\n      marketingActivity {\n        id\n        title\n        status\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/MarketingActivity/794355127\",\n  \"status\" => \"ACTIVE\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation marketingActivityUpdate($id: ID!, $status: MarketingActivityStatus!) {\n    marketingActivityUpdate(input: {id: $id, status: $status}) {\n      marketingActivity {\n        id\n        title\n        status\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/MarketingActivity/794355127\",\n      \"status\": \"ACTIVE\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation marketingActivityUpdate($id: ID!, $status: MarketingActivityStatus!) {\n  marketingActivityUpdate(input: {id: $id, status: $status}) {\n    marketingActivity {\n      id\n      title\n      status\n    }\n  }\n}"
        

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

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