Choose a version:

MarketingActivity

object

Requires read_marketing_events access scope.

The marketing activity resource represents marketing that a merchant created through an app.

Anchor to FieldsFields

Anchor to activityListUrlactivityListUrl •URL: The URL of the marketing activity listing page in the marketing section.
Anchor to adminEditUrladminEditUrl •URL! non-null: The admin url used to edit this activity.
Anchor to adSpendadSpend •MoneyV2: The amount spent on the marketing activity.
Anchor to appapp •App! non-null: The app which created this marketing activity.
Anchor to appErrorsappErrors •MarketingActivityExtensionAppErrors: The errors generated when an app publishes the marketing activity.
Anchor to automationStepTypeautomationStepType •String: The step type of a marketing automation activity.
Anchor to budgetbudget •MarketingBudget: The allocated budget for the marketing activity.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the marketing activity was created.
Anchor to errorOccurredAterrorOccurredAt •DateTime: The time at which the most recent error occurred, which is set by the app.
Anchor to flowEditorUrlflowEditorUrl •URL: The flow editor URL to which the marketing activity is associated.
Anchor to formDataformData •String: The completed content in the marketing activity creation form.
Anchor to hierarchyLevelhierarchyLevel •MarketingActivityHierarchyLevel: The hierarchy level of the marketing activity.
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.
Anchor to marketingEventmarketingEvent •MarketingEvent: Associated marketing event of this marketing activity.
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 scheduledToEndAtscheduledToEndAt •DateTime: The scheduled end time of the marketing activity, which is set by the app.
Anchor to scheduledToStartAtscheduledToStartAt •DateTime: The scheduled start time of the marketing activity, which is set by the app.
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.
Anchor to statusBadgeTypeV2statusBadgeTypeV2 •BadgeType: The severity of the marketing activity's status.
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.
Anchor to targetStatustargetStatus •MarketingActivityStatus: The status to which the marketing activity is currently transitioning.
Anchor to titletitle •String! non-null: The marketing activity's title, which is rendered on the marketing listing page.
Anchor to trackingOpenstrackingOpens •Boolean! non-null: Whether the marketing activity is tracking opens.
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.

Deprecated fields

Anchor to marketingChannelmarketingChannel •MarketingChannel! non-nullDeprecated
Anchor to statusBadgeTypestatusBadgeType •MarketingActivityStatusBadgeType Deprecated

Was this section helpful?

Anchor to QueriesQueries

Anchor to marketingActivities marketingActivities •query: A list of marketing activities associated with the marketing app.
Anchor to marketingActivity marketingActivity •query: Returns a MarketingActivity resource by ID.

Was this section helpful?

Anchor to MutationsMutations

Anchor to marketingActivityCreate marketingActivityCreate •mutation: Create new marketing activity. Marketing activity app extensions are deprecated and will be removed in the near future.
Anchor to marketingActivityCreateExternal marketingActivityCreateExternal •mutation: Creates a new external marketing activity.
Anchor to marketingActivityUpdate marketingActivityUpdate •mutation: Updates a marketing activity with the latest information. Marketing activity app extensions are deprecated and will be removed in the near future.
Anchor to marketingActivityUpdateExternal marketingActivityUpdateExternal •mutation: Update an external marketing activity.
Anchor to marketingActivityUpsertExternal marketingActivityUpsertExternal •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.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to Node Node •interface

Was this section helpful?