Skip to main content
Anchor to MarketingEngagementsDeletePayload

MarketingEngagementsDeletePayload

payload

Return type for marketingEngagementsDelete mutation.

Anchor to FieldsFields

Anchor to resultresult
•String

Informational message about the engagement data that has been marked for deletion.

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 marketingEngagementsDeletemarketingEngagementsDelete
•mutation

Marks channel-level engagement data such that it no longer appears in reports. Activity-level data cannot be deleted directly, instead the MarketingActivity itself should be deleted to hide it from reports.

Arguments

Anchor to channelHandlechannelHandle
•String

The handle of the channel for which engagement data should be deleted.

Anchor to deleteEngagementsForAllChannelsdeleteEngagementsForAllChannels
•Boolean
Default:false

When true, engagements for all channels that belong to the api client will be deleted.

Was this section helpful?