The input fields required to update a marketing activity.
Access Scopes
Fields
adSpend:
MoneyInput -
The cumulative amount spent on the marketing activity.
budget:
MarketingActivityBudgetInput -
The budget for the marketing activity.
context:
String -
Encoded context provided by Shopify during the update marketing activity callback.
errors:
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](/api/marketing-activities/statuses#failed-status).
formData:
String -
The form data of the marketing activity. This is only used if the marketing activity is
integrated with the external editor.
marketedResources:
ID -
A list of the item IDs that were marketed in this marketing activity. Valid types for these items are:
* `Product`
* `Shop`
marketingRecommendationId:
ID -
The ID of the recommendation that the marketing activity was created from, if one exists.
status:
MarketingActivityStatus -
The current state of the marketing activity. Learn more about
[marketing activities statuses](/api/marketing-activities/statuses).
targetStatus:
MarketingActivityStatus -
The target state that the marketing activity is transitioning to. Learn more about [marketing activities statuses](/api/marketing-activities/statuses).
title:
String -
The title of the marketing activity.
urlParameterValue:
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.
utm:
UTMInput -
Specifies the
[Urchin Traffic Module (UTM) parameters](https://en.wikipedia.org/wiki/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.