MarketingActivity

Anchor to activityListUrlactivityListUrl

•URL

The URL of the marketing activity listing page in the marketing section.

Anchor to adSpendadSpend

•MoneyV2

The amount spent on the marketing activity.

Show fields

Anchor to appapp

•App!non-null

The app which created this marketing activity.

Show fields

Anchor to appErrorsappErrors

•MarketingActivityExtensionAppErrors

The errors generated when an app publishes the marketing activity.

Show fields

Anchor to budgetbudget

•MarketingBudget

The allocated budget for the marketing activity.

Show fields

Anchor to createdAtcreatedAt

•DateTime!non-null

The date and time when the marketing activity was created.

Anchor to formDataformData

•String

The completed content in the marketing activity creation form.

Anchor to hierarchyLevelhierarchyLevel

•MarketingActivityHierarchyLevel

The hierarchy level of the marketing activity.

Show enum values

Anchor to idid

•ID!non-null

A globally-unique ID.

Anchor to inMainWorkflowVersioninMainWorkflowVersion

•Boolean!non-null

Whether the marketing activity is in the main workflow version of the marketing automation.

Anchor to isExternalisExternal

•Boolean!non-null

The marketing activity represents an external marketing activity.

Anchor to marketingChannelTypemarketingChannelType

•MarketingChannel!non-null

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

Show enum values

Anchor to marketingEventmarketingEvent

•MarketingEvent

Associated marketing event of this marketing activity.

Show fields

Anchor to parentActivityIdparentActivityId

•ID

ID of the parent activity of this marketing activity.

Anchor to parentRemoteIdparentRemoteId

•String

ID of the parent activity of this marketing activity.

Anchor to sourceAndMediumsourceAndMedium

•String!non-null

A contextual description of the marketing activity based on the platform and tactic used.

Anchor to statusstatus

•MarketingActivityStatus!non-null

The current state of the marketing activity.

Show enum values

Anchor to statusBadgeTypeV2statusBadgeTypeV2

•BadgeType

The severity of the marketing activity's status.

Show enum values

Anchor to statusLabelstatusLabel

•String!non-null

The rendered status of the marketing activity.

Anchor to statusTransitionedAtstatusTransitionedAt

•DateTime

The date and time when the activity's status last changed.

Anchor to tactictactic

•MarketingTactic!non-null

The method of marketing used for this marketing activity.

Show enum values

Anchor to targetStatustargetStatus

•MarketingActivityStatus

The status to which the marketing activity is currently transitioning.

Show enum values

Anchor to titletitle

•String!non-null

The marketing activity's title, which is rendered on the marketing listing page.

Anchor to updatedAtupdatedAt

•DateTime!non-null

The date and time when the marketing activity was updated.

Anchor to urlParameterValueurlParameterValue

•String

The value portion of the URL query parameter used in attributing sessions to this activity.

Anchor to utmParametersutmParameters

•UTMParameters

The set of Urchin Tracking Module used in the URL for tracking this marketing activity.

Show fields

Deprecated fields

Anchor to marketingChannelmarketingChannel

•MarketingChannel!non-nullDeprecated

Anchor to statusBadgeTypestatusBadgeType

•MarketingActivityStatusBadgeTypeDeprecated

Anchor to marketingActivitiesmarketingActivities

•query

A list of marketing activities associated with the marketing app.

Show fields

Anchor to marketingActivitymarketingActivity

•query

Returns a MarketingActivity resource by ID.

Show fields

Anchor to marketingActivityCreatemarketingActivityCreate

•mutation

Create new marketing activity.

Show arguments and payload

Arguments

Anchor to inputinput

•MarketingActivityCreateInput!required

The Input of marketing activity create.

Show input fields

---

Fields

Anchor to marketingActivitymarketingActivity

•MarketingActivity

The created marketing activity.

Show fields

Anchor to redirectPathredirectPath

•String

The path to return back to shopify admin from embedded editor.

Anchor to userErrorsuserErrors

•[UserError!]!non-null

The list of errors that occurred from executing the mutation.

Show fields

Anchor to marketingActivityCreateExternalmarketingActivityCreateExternal

•mutation

Creates a new external marketing activity.

Show arguments and payload

Arguments

Anchor to inputinput

•MarketingActivityCreateExternalInput!required

The input field for creating an external marketing activity.

Show input fields

---

Fields

Anchor to marketingActivitymarketingActivity

•MarketingActivity

The external marketing activity that was created.

Show fields

Anchor to userErrorsuserErrors

•[MarketingActivityUserError!]!non-null

The list of errors that occurred from executing the mutation.

Show fields

Anchor to marketingActivityUpdatemarketingActivityUpdate

•mutation

Updates a marketing activity with the latest information.

Show arguments and payload

Arguments

Anchor to inputinput

•MarketingActivityUpdateInput!required

The Input of the marketing activity.

Show input fields

---

Fields

Anchor to marketingActivitymarketingActivity

•MarketingActivity

The updated marketing activity.

Show fields

Anchor to redirectPathredirectPath

•String

The redirect path from the embedded editor to the Shopify admin.

Anchor to userErrorsuserErrors

•[UserError!]!non-null

The list of errors that occurred from executing the mutation.

Show fields

Anchor to marketingActivityUpdateExternalmarketingActivityUpdateExternal

•mutation

Update an external marketing activity.

Show arguments and payload

Arguments

Anchor to inputinput

•MarketingActivityUpdateExternalInput!required

The input field for updating an external marketing activity.

Show input fields

Anchor to marketingActivityIdmarketingActivityId

•ID

The ID of the marketing activity. Specify either the marketing activity ID, remote ID, or UTM to update the marketing activity.

Anchor to remoteIdremoteId

•String

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. Specify either the marketing activity ID, remote ID, or UTM to update the marketing activity.

Anchor to utmutm

•UTMInput

Specifies the Urchin Traffic Module (UTM) parameters that are associated with a related marketing campaign. Specify either the marketing activity ID, remote ID, or UTM to update the marketing activity.

Show input fields

---

Fields

Anchor to marketingActivitymarketingActivity

•MarketingActivity

The updated marketing activity.

Show fields

Anchor to userErrorsuserErrors

•[MarketingActivityUserError!]!non-null

The list of errors that occurred from executing the mutation.

Show fields

Anchor to marketingActivityUpsertExternalmarketingActivityUpsertExternal

•mutation

Creates a new external marketing activity or updates an existing one. When optional fields are absent or null, associated information will be removed from an existing marketing activity.

Show arguments and payload

Arguments

Anchor to inputinput

•MarketingActivityUpsertExternalInput!required

The input field for creating or updating an external marketing activity.

Show input fields

---

Fields

Anchor to marketingActivitymarketingActivity

•MarketingActivity

The external marketing activity that was created or updated.

Show fields

Anchor to userErrorsuserErrors

•[MarketingActivityUserError!]!non-null

The list of errors that occurred from executing the mutation.

Show fields

Anchor to NodeNode

•interface