marketingEngagementCreate
mutation

Choose a version:

Requires write_marketing_events access scope.

Creates a new marketing engagement for a marketing activity or a marketing channel.

Arguments

Anchor to channelHandle channelHandle String: The unique string identifier of the channel to which the engagement metrics are being provided. This should be set when and only when providing channel-level engagements. This should be nil when providing activity-level engagements. For the correct handle for your channel, contact your partner manager.
Anchor to marketingActivityId marketingActivityId ID: The identifier of the marketing activity for which the engagement metrics are being provided. This or the remoteId should be set when and only when providing activity-level engagements. This should be nil when providing channel-level engagements.
Anchor to marketingEngagement marketingEngagement MarketingEngagementInput! required: The marketing engagement's attributes.
Anchor to remoteId remoteId String: The ID of an activity that's hosted outside of Shopify. This or the marketingActivityId should be set when and only when providing activity-level engagements. This should be nil when providing channel-level engagements.

Was this section helpful?

Anchor to MarketingEngagementCreatePayload.marketingEngagement marketingEngagement MarketingEngagement: The marketing engagement that was created. This represents customer activity taken on a marketing activity or a marketing channel.
Anchor to MarketingEngagementCreatePayload.userErrors userErrors [MarketingActivityUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?