mutationevent.schema.json

{
    "meta:license": [
        "Copyright 2018 Adobe Systems Incorporated. All rights reserved.",
        "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license",
        "you may not use this file except in compliance with the License. You may obtain a copy",
        "of the License at https://creativecommons.org/licenses/by/4.0/"
    ],
    "$id": "https://ns.adobe.com/experience/campaign/mutationevent",
    "$schema": "http://json-schema.org/draft-06/schema#",
    "title": "Adobe Campaign Mutation Event",
    "type": "object",
    "description": "Adobe Campaign mutation event.",
    "definitions": {
        "mutationevent": {
            "properties": {
                "xdm:timestamp": {
                    "title": "Timestamp",
                    "type": "string",
                    "format": "date-time",
                    "description": "The time when the first event of the interaction occurred.",
                    "meta:titleId": "mutationevent##xdm:timestamp##title##6031",
                    "meta:descriptionId": "mutationevent##xdm:timestamp##description##14931"
                },
                "xdm:web": {
                    "title": "Web",
                    "$ref": "https://ns.adobe.com/xdm/context/webinfo",
                    "description": "Link clicks, web page details, referrer information, and browser details.",
                    "meta:titleId": "mutationevent##xdm:web##title##48981",
                    "meta:descriptionId": "mutationevent##xdm:web##description##96911"
                },
                "xdm:directMarketing": {
                    "title": "Direct Marketing",
                    "$ref": "https://ns.adobe.com/xdm/context/direct-marketing",
                    "description": "The events and properties related to direct/outbound marketing such as email, direct mail, texts and in-app notifications.",
                    "meta:titleId": "mutationevent##xdm:directMarketing##title##67481",
                    "meta:descriptionId": "mutationevent##xdm:directMarketing##description##17421"
                },
                "https://ns.adobe.com/experience/campaign/message": {
                    "title": "A single message sent to a recipient.",
                    "type": "object",
                    "properties": {
                        "xdm:quarantine": {
                            "title": "Quarantine",
                            "type": "boolean",
                            "default": false,
                            "description": "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.",
                            "meta:titleId": "mutationevent##xdm:quarantine##title##73571",
                            "meta:descriptionId": "mutationevent##xdm:quarantine##description##26691"
                        },
                        "xdm:reason": {
                            "title": "Reason",
                            "type": "string",
                            "meta:enum": {
                                "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"
                            },
                            "description": "The reason why the message could/would not be delivered.",
                            "default": "undefined",
                            "meta:titleId": "mutationevent##xdm:reason##title##4031",
                            "meta:descriptionId": "mutationevent##xdm:reason##description##34821"
                        }
                    },
                    "meta:titleId": "mutationevent##https://ns.adobe.com/experience/campaign/message##title##83251"
                }
            }
        }
    },
    "allOf": [
        {
            "$ref": "#/definitions/mutationevent"
        }
    ],
    "meta:status": "stable",
    "meta:titleId": "mutationevent##title##92191",
    "meta:descriptionId": "mutationevent##description##54991"
}