Skip to main content
Anchor to MarketingActivityUpdateInput

MarketingActivityUpdateInput

input_object

The input fields required to update a marketing activity.

Anchor to FieldsFields

Anchor to budgetbudget
•MarketingActivityBudgetInput

The budget for the marketing activity.

Anchor to errorserrors
•JSON

The error messages that were generated when the app was trying to complete the activity. Learn more about the JSON format expected for error messages.

Anchor to formDataformData
•String

The form data of the marketing activity. This is only used if the marketing activity is integrated with the external editor.

Anchor to idid
•ID!non-null

The ID of the marketing activity.

Anchor to marketedResourcesmarketedResources
•[ID!]

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

  • Product
  • Shop
Anchor to marketingRecommendationIdmarketingRecommendationId
•ID

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

Anchor to statusstatus
•MarketingActivityStatus

The current state of the marketing activity. Learn more about marketing activities statuses.

Anchor to targetStatustargetStatus
•MarketingActivityStatus

The target state that the marketing activity is transitioning to. Learn more about marketing activities statuses.

Anchor to titletitle
•String

The title of the marketing activity.

Anchor to urlParameterValueurlParameterValue
•String

Value for a query parameter that gets inserted into storefront URLs for matching storefront traffic to this activity. This feature is currently available on a limited basis to some partners only. UTMs should continue to be used for most partners. Both the URL parameter value and UTM parameters can be set.

Anchor to utmutm
•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. The utm field can only be set once and never modified.

Deprecated fields

Anchor to adSpendadSpend
•MoneyInputDeprecated
Anchor to contextcontext
•StringDeprecated
Was this section helpful?

Anchor to Mutations using this inputMutations using this input

Was this section helpful?