stack

Home > @infiniteobjects/shopify-data-manager > AdminTypes > MarketingActivityUpdateInput

AdminTypes.MarketingActivityUpdateInput interface

The input fields required to update a marketing activity.

Signature:

export interface MarketingActivityUpdateInput 

Properties

Property Modifiers Type Description
budget?   InputMaybe<MarketingActivityBudgetInput> (Optional) The budget for the marketing activity.
errors?   InputMaybe<Scalars[‘JSON’][‘input’]> (Optional) 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?   InputMaybe<Scalars[‘String’][‘input’]> (Optional) The form data of the marketing activity. This is only used if the marketing activity is integrated with the external editor.
id   Scalars[‘ID’][‘input’] The ID of the marketing activity.
marketedResources?   InputMaybe<Array<Scalars[‘ID’][‘input’]>> (Optional) A list of the item IDs that were marketed in this marketing activity. Valid types for these items are: * Product * Shop
marketingRecommendationId?   InputMaybe<Scalars[‘ID’][‘input’]> (Optional) The ID of the recommendation that the marketing activity was created from, if one exists.
status?   InputMaybe<MarketingActivityStatus | `${MarketingActivityStatus}`> (Optional) The current state of the marketing activity. Learn more about [marketing activities statuses](/api/marketing-activities/statuses).
targetStatus?   InputMaybe<MarketingActivityStatus | `${MarketingActivityStatus}`> (Optional) The target state that the marketing activity is transitioning to. Learn more about [marketing activities statuses](/api/marketing-activities/statuses).
title?   InputMaybe<Scalars[‘String’][‘input’]> (Optional) The title of the marketing activity.
utm?   InputMaybe<UtmInput> (Optional) 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.