User

The user file is used to create and update users on the MX platform. Usually, each user record will represent a given end-user. Details can be discussed with the MX integrations team.

User Fields

Field Name	Data Type	Description
birthdate	String	The birthdate of the user. ISO 8601 format, without a timestamp. (YYYY-MM-DD).
credit_score	Integer	The credit score of the user.
email	String	Email 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_name	String	The first name of the user. Max length is 50.
gender	String	One of MALE or FEMALE.
guid	String	The unique identifier for the user. Defined by MX.
id	String	The 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_disabled	Boolean	This indicates whether a user is disabled from logging in. Defaults to false.
is_excluded_from_analytics	Boolean	Flag indicating whether the user should be excluded from analytics activities.
last_name	String	The last name of the user. Max length is 50.
metadata	String	Additional information a partner can store on the user.
phone	String	Phone number of the user. Max length is 15.
zip_code	String	The postal code of the user. Postal codes from the following countries are supported: Canada, Indonesia, Japan, Malaysia, Philippines, South Korea, Thailand, United States, Vietnam.

User File Parameters

note

The action field tells us what data operation to perform for each row in the file. Options are upsert (an insert/update depending on if the object already exists) and delete (which will destroy the record). If no action is provided the default action is upsert.

note

The skip_webhook parameter prevents a webhook being sent for the action effected by each row. Accepted values are true or false. If skip_webhook is not provided, MX will default to your internal batch configuration setting.

Field	Required for Upsert?	Required for Delete?	Type
id	Yes	Yes	String
action	No	No	String
birthdate	No	No	String
credit_score	No	No	String
email	No	No	String
first_name	No	No	String
gender	No	No	String
is_disabled	No	No	Boolean
last_name	No	No	String
metadata	No	No	String
phone	No	No	String
skip_webhook	No	No	Boolean
zip_code	No	No	String

Sample File

The following is a sample User batch CSV file.

CSV

Language:text

_10

"action","id","first_name","last_name","email","phone"

_10

"upsert","U-39XBF7","John","Smith","example@example.com","5055551234"