Users Overview

Users represent an end user using the Platform API through your web or mobile app.

Users are created by MX clients and belong to a specific client on the platform.

User Fields

Field	Data Type	Description
email	String	The end user's email address. 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)
guid	String	The unique identifier for the user defined by MX, beginning with the prefix USR-.
id	String	A unique, partner-defined, enforced identifier for the user. This value must be URL-safe. The id field must only contain letters, numbers, and the dash and underscore characters.
is_disabled	Boolean	This indicates whether the user has been disabled. Defaults to false.
metadata	String	Additional information you can store about this user. MX recommends using JSON-structured data.