Contact field definitions
The fields (attributes) listed below are included as default for every contact type in Voyado Engage. Beneath the table you can find more detailed information on some of the fields.
Standard fields
Field name (UI) | DB name | Field type | Description & example value |
Contact type | contactType | String | The contact type for the specific contact |
First name | firstName | String | Jane |
Last name | lastName | String | Doe |
Member Number | memberNumber | Sequence | 12345678 |
Social Security Number | socialSecurityNumber | SocialSecurityNumber | Validation requires it to be either Swedish or Finnish SSN. If only 10 digits are specified it is assumed that the contact is less than 100 years old |
jane@doe.com | |||
Mobile Phone | mobilePhone | PhoneNumber | +4612345678. Country calling code is required (+46) |
Registration store | createdInStore | SingleStorePicker | 1001. Once it's set it can't be updated |
Regular store | store | StorePicker | 1002. If not set then default value will be same as Registration store |
Street Address | street | String | Janes street 12 |
Zip Code | zipCode | String | 123 45 |
City | city | String | Stockholm |
Care Of | careOf | String | |
Country | country | String | Sweden |
Weighted RFM (1-100) | rfm | Number | Calculated and set in Voyado |
Recency (1-5) | retail.keyvalue.recency | Integer | Calculated and set in Voyado |
Frequency (1-5) | retail.keyvalue.frequency | Integer | Calculated and set in Voyado |
Monetary (1-5) | retail.keyvalue.monetary | Integer | Calculated and set in Voyado |
Age | age | Integer | 28. Is automatically set if socialSecurityNumber or birthDay is populated. |
Birthday | birthDay | Date | 1990-01-01. Should be in format YYYY-MM-DD or ISO8601 |
Gender | gender | Gender | Male or Female |
Nps-grade | nps.grade | Integer | Set by Voyado |
Nps-date | nps.datetime | DateTime | Set by Voyado |
Average Nps-grade | nps.averagegrade | Number | Calculated in Voyado |
External ID | externalId | String | Identification key from external systems. Used when Voyado isn't master. |
Country Code | countryCode | CountryCode | SE (Alpha-2 code ISO-3166) |
Mobile Phone
Each contact can only have one phone number connected to them, and the number should always be formatted as MSISDN (Mobile Station International Subscriber Directory Number), as a "+" prefix followed by [countrycode][phonenumber]. For example: +46707104603.
Voyado Engage uses libphonenumber. a Google open source library, to validate phone numbers internationally. For a deep dive into the area of phone number validation and all the issues that can occur, you can read this page.
The library libphonenumber works by setting a "default" country code, from which all numbers are validated. A number is considered valid if you, by calling that exact number from a phone in the "default" country, could succeed in placing a call.
However, this can quickly become complex, making it important to follow the standard. Consider these cases:
Case 1: If the default country is SE, the following numbers are valid: 0707104603, +46707104603, 0046707104603. This is because "00" is the international calling code from Sweden.
Case 2: If the default country is US, the same number, 0046707104603, would now not be valid, since "00" is not an international calling prefix in the US.
So, although it will sometimes work, you should never send phone numbers using only the country code (without prefixing "+"). There are many ambiguities where it is impossible to distinguish a country code from a regional code.
For example, 468211415 will be validated as a number with regional code 046 (Lund) instead of a Swedish number (46) if called from regional code 08 (Stockholm). Thereby it will be stored in the database as 46468211415. Similar things can happen with Norwegian numbers that have country code 47, but local numbers may themselves also start with "47".
Important
A phone number should always be made of a "+" prefix followed by [countrycode][phonenumber].
Important
Using "local" phone numbers based on the default country code should only be done when manually entering phone numbers in Engage, i.e. when searching, or using the LoyaltyBar, or on registration forms.
All emails in Engage are validated according to RFC 5322, addr-spec.
Read the details of RFC 5322 here.
Country code
Country codes follow the ISO 3166, alpha-2 naming standard. Some useful examples are:
SE = Sweden
NO = Norway
GB = Great Britain (and Northern Ireland)
NL = Netherlands
IE = Ireland
Preferences and accept flags
A contact also has several optional preference fields defining how they wish to be contacted, known as accept flags.
Field name (UI) | DB name | Field type | Description & example value |
Accepts Email | acceptsEmail | Bool | True / False |
Accepts Postal | acceptsPostal | Bool | True / False |
Accepts SMS | acceptsSms | Bool | True / False |
Important
If these accept flags are used, they must be set to either true or false, and never to null.