MarketingEngagementCreatePayload

payload

Return type for marketingEngagementCreate mutation.

Anchor to FieldsFields

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

Was this section helpful?

Anchor to Mutations with this payloadMutations with this payload

Anchor to marketingEngagementCreate marketingEngagementCreate

•mutation

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

Arguments

Anchor to marketingActivityIdmarketingActivityId

•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 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. This or the marketingActivityId should be set when and only when providing activity-level engagements. This should be nil when providing channel-level engagements.

Anchor to channelHandlechannelHandle

•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 marketingEngagementmarketingEngagement

•MarketingEngagementInput!

required

The marketing engagement's attributes.

Was this section helpful?