Marketing Activity User Error
An error that occurs during the execution of marketing activity and engagement mutations.
Anchor to FieldsFields
- code (MarketingActivityUserErrorCode)
- field ([String!])
- message (String!)
- Anchor to codecode•Marketing
Activity User Error Code The error code.
Show enum values
- Anchor to fieldfield•[String!]
The path to the input field that caused the error.
- Anchor to messagemessage•String!non-null
The error message.
Anchor to MutationsMutations
- marketingActivitiesDeleteAllExternal (MarketingActivitiesDeleteAllExternalPayload)
- marketingActivityDeleteExternal (MarketingActivityDeleteExternalPayload)
- marketingActivityUpdateExternal (MarketingActivityUpdateExternalPayload)
- marketingActivityUpsertExternal (MarketingActivityUpsertExternalPayload)
- marketingEngagementCreate (MarketingEngagementCreatePayload)
- •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
- Anchor to marketingActivityIdmarketing•ID
Activity Id The ID of the marketing activity. A marketing activity ID or remote ID must be provided.
- Anchor to remoteIdremote•String
Id 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.
Arguments
- •mutation
Update an external marketing activity.
Show payload
- Anchor to inputinput•Marketing
Activity Update External Input! required The input field for updating an external marketing activity.
Show input fields
- Anchor to marketingActivityIdmarketing•ID
Activity Id The ID of the marketing activity. Specify either the marketing activity ID, remote ID, or UTM to update the marketing activity.
- Anchor to remoteIdremote•String
Id 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
Arguments
- •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
- Anchor to inputinput•Marketing
Activity Upsert External Input! required The input field for creating or updating an external marketing activity.
Show input fields
Arguments
- •mutation
Creates a new marketing engagement for a marketing activity.
Show payload
- Anchor to channelHandlechannel•String
Handle Deprecated - Anchor to marketingActivityIdmarketing•ID
Activity 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.
- Anchor to marketingEngagementmarketing•Marketing
Engagement Engagement Input! required The marketing engagement's attributes.
Show input fields
- Anchor to remoteIdremote•String
Id 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.
Arguments
Deprecated mutations
- marketingActivityCreateExternal (MarketingActivityCreateExternalPayload): deprecated
- marketingEngagementsDelete (MarketingEngagementsDeletePayload): deprecated
- •mutationDeprecated
Show payload
- Anchor to inputinput•Marketing
Activity Create External Input! required The input field for creating an external marketing activity.
Show input fields
Arguments
- •mutationDeprecated
Show payload
- Anchor to channelHandlechannel•String
Handle Deprecated - Anchor to deleteEngagementsForAllChannelsdelete•Boolean
Engagements For All Channels DeprecatedDefault:false
Arguments