Deletes all external marketing activities. Deletion is performed by a background job, as it may take a bit of time to complete if a large number of activities are to be deleted. Attempting to create or modify external activities before the job has completed will result in the create/update/upsert mutation returning an error.

Anchor to marketingActivityCreateExternal marketingActivityCreateExternal

•mutation

Creates a new external marketing activity.

Arguments

Anchor to inputinput

•MarketingActivityCreateExternalInput!

required

The input field for creating an external marketing activity.

Anchor to marketingActivityDeleteExternal marketingActivityDeleteExternal

•mutation

Deletes an external marketing activity.

Anchor to marketingActivityIdmarketingActivityId •ID: The ID of the marketing activity. A marketing activity ID or remote ID must be provided.
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. A marketing activity ID or remote ID must be provided.

Anchor to marketingActivityUpdateExternal marketingActivityUpdateExternal

•mutation

Update an external marketing activity.

Arguments

Anchor to inputinput

•MarketingActivityUpdateExternalInput!

required

The input field for updating an external marketing activity.

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.

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.

Arguments

Anchor to inputinput

•MarketingActivityUpsertExternalInput!

required

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

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.

Anchor to marketingEngagementsDelete marketingEngagementsDelete

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

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?

Anchor to InterfacesInterfaces

Anchor to DisplayableError DisplayableError •interface

Was this section helpful?