MarketingActivityUpdateInput

Version 2019-04 (latest)

Specifies the input fields required to update a marketing activity.

Show definition

"""
Specifies the input fields required to update a marketing activity.
"""
input MarketingActivityUpdateInput {
  """
  The cumulative amount spent on this marketing activity.
  """
  adSpend: MoneyInput
  """
  The budget for this marketing activity.
  """
  budget: MarketingActivityBudgetInput
  """
  Encoded context provided by Shopify during the update marketing activity
  callback. This argument is deprecated: This context is no longer needed by
  Shopify in the callback.
  """
  context: String
  """
  Error messages generated when app was trying to complete this activity.
  """
  errors: JSON
  """
  The id for this marketing activity.
  """
  id: ID!
  """
  A list of the items that were marketed in this marketing activity. Valid types for these items are:
  * Product
  * Shop (Must be your current shop).
  """
  marketedResources: [ID!]
  """
  The ID of the recommendation this marketing activity was created from, if one exists.
  """
  marketingRecommendationId: ID
  """
  The current state of the marketing activity.
  """
  status: MarketingActivityStatus
  """
  Specifies the
  Urchin Traffic Module (UTM) parameters
  that are associated with a related marketing campaign. UTMInput is required for all Marketing
  tactics except Storefront App. This utm param can be only set once and never modified.
  """
  utm: UTMInput
}

Input Fields

adSpend (MoneyInput)

The cumulative amount spent on this marketing activity.

budget (MarketingActivityBudgetInput)

The budget for this marketing activity.

context (String)

Encoded context provided by Shopify during the update marketing activity callback. This argument is deprecated: This context is no longer needed by Shopify in the callback.

errors (JSON)

Error messages generated when app was trying to complete this activity.

id (ID!) Required

The id for this marketing activity.

marketedResources ([ID!])

A list of the items that were marketed in this marketing activity. Valid types for these items are:

  • Product
  • Shop (Must be your current shop).
marketingRecommendationId (ID)

The ID of the recommendation this marketing activity was created from, if one exists.

status (MarketingActivityStatus)

The current state of the marketing activity.

utm (UTMInput)

Specifies the Urchin Traffic Module (UTM) parameters that are associated with a related marketing campaign. UTMInput is required for all Marketing tactics except Storefront App. This utm param can be only set once and never modified.

Sign up for a Partner account to get started.

Sign up