Skip to main content

User Fields

Field NameData TypeDescription
birthdateStringThe birthdate of the user. ISO 8601 format, without a timestamp. (YYYY-MM-DD).
credit_scoreIntegerThe credit score of the user.
emailStringEmail address of the user. Max length is 100. When set with Create User, this must adhere to the following format and rules: {user_name}@{domain}.{top_level_domain}.
  • user_name can include alphanumeric characters (letters and numbers) and special characters: ., !, #, $, %, &, ', *, +, /, =, ?, ^, _, {, }, |, ~, -.
  • @ symbol must exist between the user_name and domain.
  • domain must start/end with an alphanumeric character. It can include hyphens (-), but not consecutive hyphens. If there are multiple domain levels (for example, subdomains), they must follow the same rules.
  • At least one dot . must separate the domain and top_level_domain.
Examples of correct formatting:
  • user@example.com
  • user.name+test@sub-domain.example.co.uk
Examples of incorrect formatting:
  • @example.com (missing user_name)
  • user@domain..com (double dot in domain)
  • user@domain-.com (hyphen at the end of the domain)
first_nameStringThe first name of the user. Max length is 50.
genderStringOne of MALE or FEMALE.
guidStringThe unique identifier for the user. Defined by MX.
idStringThe unique partner-defined identifier for the user. It must be unique for all users belonging to a client. Can include numbers, letters, dash, and underscore. Max length is 1024.
is_disabledBooleanThis indicates whether a user is disabled from logging in. Defaults to false.
is_excluded_from_analyticsBooleanFlag indicating whether the user should be excluded from analytics activities.
last_nameStringThe last name of the user. Max length is 50.
metadataStringAdditional information a partner can store on the user.
phoneStringPhone number of the user. Max length is 15.
zip_codeStringThe postal code of the user. Postal codes from the following countries are supported: Canada, Indonesia, Japan, Malaysia, Philippines, South Korea, Thailand, United States, Vietnam.