User model
Users are visitors (or contacts) interacting with your website. A User Model provides details on user attributes and parameters that can be used within API.
Note: In the current application UI, the entity previously called “user” is now labeled as “contact”. In the API, the term "user" is still used (e.g., User model, /users endpoints), and both terms refer to the same object.
Properties
| Attributes | Type | Description |
|---|---|---|
| id | integer | A unique identifier for the user which is given by User.com automatically. |
| assigned_to | integer | A unique identifier for the agent which is given by User.com automatically. States from assignment to the user. |
| browser | string | A name of user's browser last used to visit your website. |
| browser_language | string | A user's browser language |
| city | string | A city of the user based on the user's browser. |
| company_id | integer | A unique identifier for the company which is given by User.com automatically. |
| country | string | A user's country (based on user's browser). |
| created_at | datetime | A creation date of a user. |
| custom_id | string | The unique identifier for the user which is provided by the client. |
| string(email) | A user email | |
| facebook_url | string | A URL of user's Facebook profile. |
| first_seen | string | A date for user's first website visit. |
| gender | integer | A user gender (1 - unknown, 2 - male, 3 - female) |
| google_url | string | A URL of user's Google+ profile. |
| gravatar_url | string | A user avatar url from gravatar. |
| last_contacted | datetime | A date of last contact with user - any communication (email or chat, automated or otherwise) sent from your team to the user. |
| last_ip | string | An address IP (identifier assigned to each device, e.g., laptop, printer, mobile etc.) from the last user visit. |
| last_seen | datetime | A date of last user's website visit. |
| linkedin_url | string | A URL of user's LinkedIn profile. |
| lists | list(strings) | A list of lists assigned to the user. |
| most_active_time | string | Most Active Time is an attribute that is based on historical data determined by the hours of previous use and the most likely active use. Time in this attribute is positioned in the UTC timezone, and there's no possible way to change the timezone for the attribute. |
| name | string | Read-only attribute, made from the combination of the first_name and last_name attributes. |
| notifications | boolean | A flag true/false informing if your team is receiving notifications about new chat messages from this user. |
| os_type | string | An operating system of the user’s device |
| page_views | integer | A total number of user's page visits occurrences. |
| phone_number | string | A user phone number |
| region | string | A user's region (based on user's browser). |
| resolution | string | A screen resolution of the device the user has visited your website. |
| score | integer | A number of points assinged to the user. |
| status | string | A user status (1 - visitor, 2 - user) |
| tags | list(strings) | A list of tag names. |
| timezone | string | A timezone of the user's browser. |
| twitter_url | string | A URL of user's Twitter profile. |
| unsubscribed | boolean | A flag true/false informing if user is unsubscribed from emails. |
| updated_at | datetime | A date of last user update. |
| user_key | string | A unique identifier (12 random characters) for the user which is given by User.com automatically. |
| web_push_subscription | boolean | A flag true/false informing if user is unsubscribed from webpush. |