Skip to main content
Anchor to MarketingActivityUserError

MarketingActivityUserError

object

An error that occurs during the execution of marketing activity and engagement mutations.

•MarketingActivityUserErrorCode

The error code.

Show enum values
•[String!]

The path to the input field that caused the error.

•String!
non-null

The error message.


Was this section helpful?

•mutation

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.

Show payload
•mutation

Deletes an external marketing activity.

Show payload

Arguments

•ID

The ID of the marketing activity. A marketing activity ID or remote ID must be provided.

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


•mutation

Update an external marketing activity.

Show payload

Arguments

•MarketingActivityUpdateExternalInput!
required

The input field for updating an external marketing activity.

Show input fields
•ID

The ID of the marketing activity. Specify either the marketing activity ID, remote ID, or UTM to update the marketing activity.

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

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

Show input fields

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

Show payload

Arguments

•MarketingActivityUpsertExternalInput!
required

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

Show input fields

•mutation

Creates a new marketing engagement for a marketing activity.

Show payload

Arguments

•String
Deprecated
•ID

The identifier of the marketing activity for which the engagement metrics are being provided. Exactly one of marketingActivityId, remoteId, or the deprecated channelHandle must be set.

•MarketingEngagementInput!
required

The marketing engagement's attributes.

Show input fields
•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. Exactly one of marketingActivityId, remoteId, or the deprecated channelHandle must be set.


Deprecated mutations

•mutation
Deprecated
Show payload

Arguments

•MarketingActivityCreateExternalInput!
required

The input field for creating an external marketing activity.

Show input fields

•mutation
Deprecated
Show payload

Arguments

•String
Deprecated
Anchor to deleteEngagementsForAllChannelsdeleteEngagementsForAllChannels
•Boolean
DeprecatedDefault:false


Was this section helpful?


Was this section helpful?