Marketing
An error that occurs during the execution of marketing activity and engagement mutations.
Anchor to FieldsFields
- Anchor to codecode•Marketing
Activity User Error Code The error code.
- 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
- •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.
- •Job
The asynchronous job that performs the deletion. The status of the job may be used to determine when it's safe again to create new activities.
- Anchor to userErrorsuser•[Marketing
Errors Activity User Error!]!non-null The list of errors that occurred from executing the mutation.
- •mutation
Creates a new external marketing activity.
- Anchor to inputinput•Marketing
Activity Create External Input!required The input field for creating an external marketing activity.
Arguments
- Anchor to marketingActivitymarketing•Marketing
Activity Activity The external marketing activity that was created.
- Anchor to userErrorsuser•[Marketing
Errors Activity User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Deletes an external marketing activity.
- 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
- Anchor to deletedMarketingActivityIddeleted•ID
Marketing Activity Id The ID of the marketing activity that was deleted, if one was deleted.
- Anchor to userErrorsuser•[Marketing
Errors Activity User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Update an external marketing activity.
- Anchor to inputinput•Marketing
Activity Update External Input!required The input field for updating an external marketing activity.
- 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.
Arguments
- Anchor to marketingActivitymarketing•Marketing
Activity Activity The updated marketing activity.
- Anchor to userErrorsuser•[Marketing
Errors Activity User Error!]!non-null The list of errors that occurred from executing the mutation.
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.
- Anchor to inputinput•Marketing
Activity Upsert External Input!required The input field for creating or updating an external marketing activity.
Arguments
- Anchor to marketingActivitymarketing•Marketing
Activity Activity The external marketing activity that was created or updated.
- Anchor to userErrorsuser•[Marketing
Errors Activity User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Creates a new marketing engagement for a marketing activity or a marketing channel.
- Anchor to channelHandlechannel•String
Handle 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 marketingActivityIdmarketing•ID
Activity 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 marketingEngagementmarketing•Marketing
Engagement Engagement Input!required The marketing engagement's attributes.
- 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. This or the marketingActivityId should be set when and only when providing activity-level engagements. This should be nil when providing channel-level engagements.
Arguments
- Anchor to marketingEngagementmarketing•Marketing
Engagement Engagement The marketing engagement that was created. This represents customer activity taken on a marketing activity or a marketing channel.
- Anchor to userErrorsuser•[Marketing
Errors Activity User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •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 channelHandlechannel•String
Handle The handle of the channel for which engagement data should be deleted.
- Anchor to deleteEngagementsForAllChannelsdelete•BooleanDefault:false
Engagements For All Channels When true, engagements for all channels that belong to the api client will be deleted.
Arguments
- Anchor to resultresult•String
Informational message about the engagement data that has been marked for deletion.
- Anchor to userErrorsuser•[Marketing
Errors Activity User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields