MarketingActivityUpdateInput
The input fields required to update a marketing activity.
Anchor to FieldsFields
- Anchor to budgetbudget•
The budget for the marketing activity.
- Anchor to errorserrors•
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 formDataform•
Data The form data of the marketing activity. This is only used if the marketing activity is integrated with the external editor.
- •ID!non-null
The ID of the marketing activity.
- Anchor to marketedResourcesmarketed•
Resources A list of the item IDs that were marketed in this marketing activity. Valid types for these items are:
ProductShop
- Anchor to marketingRecommendationIdmarketing•
Recommendation Id The ID of the recommendation that the marketing activity was created from, if one exists.
- Anchor to statusstatus•
The current state of the marketing activity. Learn more about marketing activities statuses.
- Anchor to targetStatustarget•
Status The target state that the marketing activity is transitioning to. Learn more about marketing activities statuses.
- Anchor to titletitle•
The title of the marketing activity.
- Anchor to urlParameterValueurl•
Parameter Value 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.
- •
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 adSpendad•
Spend The cumulative amount spent on the marketing activity.
- Anchor to contextcontext•
Encoded context provided by Shopify during the update marketing activity callback.