context customer event

base

Type: object

The customer data structure included in Contacthub

Name Type Description Example
pictureUrl string, null The URL of the customer picture
format: uri
"http://www.example.com/example"
title string, null The customer professional or academic qualifications "example"
prefix string, null The prefix added to the name of the customer "example"
firstName string, null The first name of the customer "example"
lastName string, null The last name of the customer "example"
middleName string, null The middle name of the customer "example"
gender string, null The gender of the customer "example"
dob string, null The date of birth of the customer
format: date
"1970-01-01"
locale string, null The parameter that defines the user language and the region of the customer
pattern: /^[a-z]{2}(_([a-zA-Z]{2}){1,2})?_[A-Z]{2}$/
"example"
timezone string, null The time zone of the customer
one of: "Africa/Abidjan", "Africa/Accra", "Africa/Algiers", "Africa/Bissau", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/El_Aaiun", "Africa/Johannesburg", "Africa/Khartoum", "Africa/Lagos", "Africa/Maputo", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Araguaina", "America/Argentina/Buenos_Aires", "America/Argentina/Catamarca", "America/Argentina/Cordoba", "America/Argentina/Jujuy", "America/Argentina/La_Rioja", "America/Argentina/Mendoza", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Asuncion", "America/Atikokan", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Cayenne", "America/Chicago", "America/Chihuahua", "America/Costa_Rica", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Fortaleza", "America/Fort_Nelson", "America/Glace_Bay", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Indianapolis", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Juneau", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Maceio", "America/Managua", "America/Manaus", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Nassau", "America/New_York", "America/Nipigon", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Ojinaga", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Velho", "America/Puerto_Rico", "America/Rainy_River", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Sitka", "America/St_Johns", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Vancouver", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/Syowa", "Antarctica/Troll", "Antarctica/Vostok", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Baghdad", "Asia/Baku", "Asia/Bangkok", "Asia/Barnaul", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Chita", "Asia/Choibalsan", "Asia/Colombo", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Famagusta", "Asia/Gaza", "Asia/Hebron", "Asia/Ho_Chi_Minh", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Kathmandu", "Asia/Khandyga", "Asia/Kolkata", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qyzylorda", "Asia/Riyadh", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Srednekolymsk", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Thimphu", "Asia/Tokyo", "Asia/Tomsk", "Asia/Ulaanbaatar", "Asia/Urumqi", "Asia/Ust-Nera", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yangon", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faroe", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/Stanley", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Currie", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/Perth", "Australia/Sydney", "Europe/Amsterdam", "Europe/Andorra", "Europe/Astrakhan", "Europe/Athens", "Europe/Belgrade", "Europe/Berlin", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Helsinki", "Europe/Istanbul", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Kirov", "Europe/Lisbon", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Oslo", "Europe/Paris", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/Simferopol", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Ulyanovsk", "Europe/Uzhgorod", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zaporozhye", "Europe/Zurich", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Reunion", "Pacific/Apia", "Pacific/Auckland", "Pacific/Bougainville", "Pacific/Chatham", "Pacific/Chuuk", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Pohnpei", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Wake", "Pacific/Wallis"
"Africa/Abidjan"
contacts object, null The contact information for the customer {...}
address object, null The address details of the customer {...}
credential object, null The customer login credentials {...}
educations array[object] The education history of the customer [{...}, {...}]
likes array[object] The likes list of the customer [{...}, {...}]
socialProfile object, null The social profiles of the customer {...}
jobs array[object] The job history of the customer [{...}, {...}]
subscriptions array[object] The subscriptions section for the customer [{...}, {...}]

contacts

Type: object,null

The contact information for the customer

Name Type Description Example
email string, null The e-mail address of the customer
format: email
"firstname.lastname@example.com"
fax string, null The fax number of the customer "example"
mobilePhone string, null The mobile phone number of the customer "example"
phone string, null The phone number of the customer "example"
otherContacts array[object] The list of additional contact details for the customer [{...}, {...}]
mobileDevices array[object] The list of mobile devices belonging to the customer [{...}, {...}]

otherContacts

Type: object

 

Name Type Description Example
name string The name of an additional contact entry for the customer "example"
type string, null The type of additional contact entry for the customer
one of: "MOBILE", "PHONE", "EMAIL", "FAX", "OTHER"
"MOBILE"
value string The value of the additional contact entry for the customer "example"

mobileDevices

Type: object

 

Name Type Description Example
identifier string "example"
appId string "example"
name string "example"
type string, null
one of: "IOS", "ANDROID", "WINDOWS_PHONE", "FIREOS"
"IOS"
notificationService string, null APN -> Apple Push Notification Service; GCM -> Google Cloud Messaging; WNS -> Windows Push Notification Services; ADM -> Amazon Device Messaging; SNS -> Amazon Simple Notification Service
one of: "APN", "GCM", "WNS", "ADM", "SNS"
"APN"

address

Type: object,null

The address details of the customer

Name Type Description Example
street string, null The customer address street component "example"
city string, null The customer address city component "example"
country string, null The customer address country component "example"
region string, null The customer address region component "example"
province string, null The customer address province component "example"
zip string, null The customer address zip code component "example"
geo object, null The geographic location of the customer {...}

geo

Type: object,null

The geographic location of the customer

Name Type Description Example
lat number, null The latitude coordinate for the customer 42.0
lon number, null The longitude coordinate for the customer 42.0

credential

Type: object,null

The customer login credentials

Name Type Description Example
password string, null The password of the customer "example"
username string, null The username of the customer "example"

educations

Type: object

 

Name Type Description Example
id string Required. The ID used to identify the education establishment "example"
schoolType string, null The type of education establishment
one of: "PRIMARY_SCHOOL", "SECONDARY_SCHOOL", "HIGH_SCHOOL", "COLLEGE", "OTHER"
"PRIMARY_SCHOOL"
schoolName string, null The name of the education establishment "example"
schoolConcentration string, null The study concentration or core subjects "example"
startYear integer, null The year study began 42
endYear integer, null The year study ended 42
isCurrent boolean, null The flag that defines whether the study is current true

likes

Type: object

 

Name Type Description Example
id string Required. The ID used to identify the like "example"
category string, null The category of the like "example"
name string, null The name of the like "example"
createdTime string, null The date the like was created
format: date-time
"1970-01-01T12:00:00Z"

socialProfile

Type: object,null

The social profiles of the customer

Name Type Description Example
facebook string, null The Facebook profile of the customer "example"
google string, null The Google+ profile of the customer "example"
instagram string, null The Instagram profile of the customer "example"
linkedin string, null The Linkedin profile of the customer "example"
qzone string, null The Qzone profile of the customer "example"
twitter string, null The Twitter profile of the customer "example"

jobs

Type: object

 

Name Type Description Example
id string Required. The ID used to identify the job "example"
companyIndustry string, null The industry to which the company belongs "example"
companyName string, null The name of the company "example"
jobTitle string, null The job title "example"
startDate string, null The start date of the job
format: date
"1970-01-01"
endDate string, null The end date of the job
format: date
"1970-01-01"
isCurrent boolean, null The flag that defines whether the job is current true

subscriptions

Type: object

 

Name Type Description Example
id string Required. The ID used to identify the subscription "example"
name string, null The name of the subscription "example"
type string, null The type of subscription "example"
kind string, null The kind of subscription
one of: "DIGITAL_MESSAGE", "SERVICE", "OTHER"
"DIGITAL_MESSAGE"
subscribed boolean, null The flag that defines a subscriber true
startDate string, null The start date of the subscription
format: date-time
"1970-01-01T12:00:00Z"
endDate string, null The end date of the subscription
format: date-time
"1970-01-01T12:00:00Z"
subscriberId string, null The ID used to identify the subscriber "example"
registeredAt string, null The date and time the subscription is first registered in Contacthub
format: date-time
"1970-01-01T12:00:00Z"
updatedAt string, null The date time of the last modification to the subscription in Contacthub
format: date-time
"1970-01-01T12:00:00Z"
preferences array[object] The list of customer subscription preferences [{...}, {...}]

preferences

Type: object

 

Name Type Description Example
key string, null The subscription preference key "example"
value string, null The subscription preference value "example"