Skip to content

Latest commit

 

History

History
184 lines (105 loc) · 6.01 KB

mutationevent.schema.md

File metadata and controls

184 lines (105 loc) · 6.01 KB

Adobe Campaign Mutation Event Schema

https://ns.adobe.com/experience/campaign/mutationevent

Adobe Campaign mutation event.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Stable No Forbidden Permitted adobe/experience/campaign/mutationevent.schema.json

Schema Hierarchy

  • Adobe Campaign Mutation Event https://ns.adobe.com/experience/campaign/mutationevent

Adobe Campaign Mutation Event Properties

Property Type Required Defined by
https://ns.adobe.com/experience/campaign/message object Optional Adobe Campaign Mutation Event (this schema)
xdm:directMarketing Direct marketing Optional Adobe Campaign Mutation Event (this schema)
xdm:timestamp string Optional Adobe Campaign Mutation Event (this schema)
xdm:web Web information Optional Adobe Campaign Mutation Event (this schema)
* any Additional this schema allows additional properties

A single message sent to a recipient.

https://ns.adobe.com/experience/campaign/message

  • is optional
  • type: object
  • defined in this schema

object with following properties:

Property Type Required Default
xdm:quarantine boolean Optional false
xdm:reason string Optional "undefined"

xdm:quarantine

Quarantine

Address moved to quarantine. The quarantine is set to true when the message failed to deliver in a way that indicates that no future messages will be deliverable either to this address.

xdm:quarantine

  • is optional
  • type: boolean
  • default: false
xdm:quarantine Type

boolean

xdm:reason

Reason

The reason why the message could/would not be delivered.

xdm:reason

  • is optional
  • type: string
  • default: "undefined"
xdm:reason Type

string

xdm:reason Known Values
Value Description
undefined Not defined
unknown_user The address does not exist. There is no use sending deliveries to this address.
invalid_domain The domain of the email address is incorrect or no longer exists.
unreachable An error has occurred in the message delivery chain.These addresses can be removed from the quarantine list to make another attempt.
disabled The user uses a messaging service which is accessible from the web. When the Internet Access Provider (IAP) detects a lengthy period of inactivity, it can close the user's account. Deliveries to the user's address will then be impossible.
mailbox_full The recipient's mailbox contains too many messages. This address can be removed from the quarantine list to make another attempt.
not_connected The recipient's mobile phone is switched off or not connected to the network when the message is sent.
refused The address was rejected following the application of a security rule (e.g. by an anti-spam program)
error_ignored The address is whitelisted and the message ignored.
address_undefined No address is given for the recipient.
blacklisted The address was blacklisted at the time of sending.
quarantine The address was in quarantine at the time of sending.
duplicate The address of the recipient was already in this campaign activity.
typology_rule The recipient was excluded by a 'SQL' type campaign typology rule.
business_ranking The recipient was excluded by an 'arbitration' type campaign typology rule
cancelled Delivery cancelled
quality The quality rating for this address is too low
unchecked Unqualified address
offer_missing Not eligible for the offers
over_delivery_limit The campaign activity had more than allowed number of target profiles.
expired The campaign activity exceeded the time duration to complete.
too_long Text too long
untranslatable Character not supported by encoding
control_group Control address

xdm:directMarketing

Direct Marketing

The events and properties related to direct/outbound marketing such as email, direct mail, texts and in-app notifications.

xdm:directMarketing

  • is optional
  • type: Direct marketing
  • defined in this schema

xdm:directMarketing Type

xdm:timestamp

Timestamp

The time when the first event of the interaction occurred.

xdm:timestamp

  • is optional
  • type: string
  • defined in this schema

xdm:timestamp Type

string

xdm:web

Web

Link clicks, web page details, referrer information, and browser details.

xdm:web

  • is optional
  • type: Web information
  • defined in this schema

xdm:web Type