Field Types

The AtlasHXM system supports various field types. The API aims to balance the conflicting goals of providing raw data in a machine-readable format while minimizing the number of API lookup calls needed to complete a task.

To reduce the need for additional API requests, some data will be provided as human-readable plain text strings. Locale-specific settings are ignored in the API to ensure a consistent machine-readable format. All values are case insensitive.

Field Types	Description
date	A complete date with a four-digit year. Format: yyyy-mm-dd Example: "2010-03-19"
string	Any valid UTF-8 sequence of characters. Example: "I do not like green eggs and ham. I do not like them, Sam-I-Am.”
mobilePhone.number	A plain text string with a phone number, no formatting is enforced. Example: "18663879595"
mobilePhone.countryCallingCode	A plain text string with country initial phone number code https://en.wikipedia.org/wiki/List_of_telephone_country_codes
genderCode	The plain text name of the gender. Example: "Male", "Female", “Non-Binary“, “Prefer not to say“
currencyCode	The name of the currency country code. Must exist in the ISO currency list. https://en.wikipedia.org/wiki/ISO_4217 Example: “EUR”, “BRL“, “USD“

countryCode	The code of the country. Must exist in the ISO country list. https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes Example: "AU", "US", etc.
maritalStatus	Plain text status of marriage. Example: "Single" or "Married", “Common Law“, “Domestic Partnership“, “Separated“, “Widowed”
timestamp	The UTC time that an event occurred. Format: ####-##-##T##:##:##+##:## Example: "2012-10-17T20:27:17+00:00”
email	An email address. Example: "support@atlas.com"
bool	A boolean value, true or false. Example: "true"