MarketingActivityUpsertExternalInput

input_object

The input fields for creating or updating an externally-managed marketing activity.

Anchor to FieldsFields

Anchor to adSpendadSpend •MoneyInput: The amount spent on the marketing activity.
Anchor to budgetbudget •MarketingActivityBudgetInput: The budget for this marketing activity.
Anchor to channelHandlechannelHandle •String: The unique string identifier of the channel to which this activity belongs. For the correct handle for your channel, contact your partner manager.
Anchor to endend •DateTime: The date and time at which the activity started. On creation, if this field is omitted or set to null, the current time will be used if the status is set to INACTIVE or DELETED_EXTERNALLY .
Anchor to hierarchyLevelhierarchyLevel •MarketingActivityHierarchyLevel: The hierarchy level of the activity within a campaign. The hierarchy level can't be updated.
Anchor to marketingChannelTypemarketingChannelType •MarketingChannel! non-null: The medium through which the marketing activity and event reached consumers. This is used for reporting aggregation.
Anchor to parentRemoteIdparentRemoteId •String: The remote ID for the parent marketing activity, if creating hierarchical activities.
Anchor to referringDomainreferringDomain •String: The domain from which ad clicks are forwarded to the shop.
Anchor to remoteIdremoteId •String! non-null: A custom unique identifier for the marketing activity, which can be used to manage the activity and send engagement metrics without having to store our marketing activity ID in your systems.
Anchor to remotePreviewImageUrlremotePreviewImageUrl •URL: The URL for a preview image that's used for the marketing activity.
Anchor to remoteUrlremoteUrl •URL! non-null: The URL for viewing and/or managing the activity outside of Shopify.
Anchor to scheduledEndscheduledEnd •DateTime: The date and time at which the activity is scheduled to end.
Anchor to scheduledStartscheduledStart •DateTime: The date and time at which the activity is scheduled to start.
Anchor to startstart •DateTime: The date and time at which the activity started. On creation, if this field is omitted or set to null, the current time will be used.
Anchor to statusstatus •MarketingActivityExternalStatus! non-null: The status of the marketing activity.
Anchor to tactictactic •MarketingTactic! non-null: The method of marketing used for this marketing activity. The marketing tactic determines which default fields are included in the marketing activity.
Anchor to titletitle •String! non-null: 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. Either the URL parameter value or UTM can be set, but not both.

Was this section helpful?