Anchor to section titled 'undefined'

MarketingActivityUpsertExternalInput
input_object

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


The amount spent on the marketing activity.

The budget for this marketing activity.

The unique string identifier of the channel to which this activity belongs. For the correct handle for your channel, contact your partner manager.

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 .

The hierarchy level of the activity within a campaign. The hierarchy level can't be updated.

The medium through which the marketing activity and event reached consumers. This is used for reporting aggregation.

The remote ID for the parent marketing activity, if creating hierarchical activities.

The domain from which ad clicks are forwarded to the shop.

The ID of an activity that's hosted outside of Shopify.

The URL for a preview image that's used for the marketing activity.

The URL for viewing and/or managing the activity outside of Shopify.

The date and time at which the activity is scheduled to end.

The date and time at which the activity is scheduled to start.

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.

The status of the marketing activity.

The method of marketing used for this marketing activity. The marketing tactic determines which default fields are included in the marketing activity.

The title of the marketing activity.

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. Either the URL parameter value or UTM can be set, but not both.


Was this section helpful?


Was this section helpful?