xdm/docs/reference/datatypes/b2b-contact.schema.json at master · RussStringham/xdm · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
{
    "meta:license": [
        "Copyright 2020 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/xdm/common/b2b-contact",
    "$schema": "http://json-schema.org/draft-06/schema#",
    "title": "B2B Contact",
    "type": "object",
    "meta:extensible": true,
    "meta:abstract": true,
    "description": "This Data Type is used to capture B2B Contact specific attributes.",
    "definitions": {
        "b2b-contact": {
            "properties": {
                "xdm:ID": {
                    "title": "Contact Record Id",
                    "description": "Unique record id of the contact in the source system.",
                    "type": "string"
                },
                "xdm:accountID": {
                    "title": "Contact Account id",
                    "description": "ID of the account that’s the parent of this contact.",
                    "type": "string"
                },
                "xdm:leadSource": {
                    "title": "Lead Source",
                    "description": "Field recording what source the lead originated from.",
                    "type": "string"
                },
                "xdm:extendedContact": {
                    "title": "Contact Extended Properties",
                    "description": "Holds additional properties for a person to be recognized as a contact in the business-to-business space.",
                    "$ref": "https://ns.adobe.com/xdm/common/contact-lead"
                },
                "xdm:preferences": {
                    "title": "Contact Preferences",
                    "description": "Holds opt out values for different channels as selected by the contact.",
                    "$ref": "https://ns.adobe.com/xdm/context/optinout"
                }
            }
        }
    },
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"
        },
        {
            "$ref": "#/definitions/b2b-contact"
        }
    ],
    "required": [
        "xdm:ID",
        "xdm:accountID"
    ],
    "meta:status": "deprecated",
    "examples": [
        {
            "xdm:ID": "11110000",
            "xdm:accountID": "",
            "xdm:leadSource": "Lead Source",
            "xdm:extendedContact": {
                "xdm:type": "",
                "xdm:ownerID": "",
                "xdm:isDeleted": false,
                "xdm:emailBouncedDate": "2018-12-20T15:52:25+00:00",
                "xdm:emailBouncedReason": "Bounced Reason Here",
                "xdm:isEmailBounced": true,
                "xdm:description": "Contact/Lead description here",
                "xdm:status": "Status",
                "xdm:timezone": "",
                "xdm:jigsaw": "12345"
            },
            "xdm:identityMap": {
                "EMAIL": [
                    {
                        "xdm:id": "jane@doe.com"
                    }
                ]
            },
            "xdm:preferences": {
                "https://ns.adobe.com/xdm/channels/email": "pending",
                "https://ns.adobe.com/xdm/channels/phone": "out",
                "https://ns.adobe.com/xdm/channels/sms": "in",
                "https://ns.adobe.com/xdm/channels/fax": "not_provided",
                "https://ns.adobe.com/xdm/channels/direct-mail": "not_provided",
                "https://ns.adobe.com/xdm/channels/apns": "not_provided",
                "xdm:globalOptout": false,
                "xdm:optOutDetails": {
                    "xdm:email": {
                        "xdm:optOutReason": "Reason here",
                        "xdm:optOutDate": "2018-01-20T15:52:25+00:00"
                    },
                    "xdm:phone": {
                        "xdm:optOutReason": "Reason here",
                        "xdm:optOutDate": "2018-01-20T15:52:25+00:00"
                    }
                }
            }
        }
    ]
}