User properties

User properties overview

Properties are individual fields to be captured for a customer. For example, name, phone number, gender, email address and more. There are several predefined fields that you can use to capture a user's data. You can also create custom properties if required.

A customer is identified with a unique identifier userId. This can be any unique identifier such as mobile number, email adress, or any other identifier. However, you can set only one property for the userId for your org.

info

This is enabled only for https://cloud.yellow.ai

There are two types of user data that is supported in User 360:

1. User properties

   i. System user properties: Default data that you can capture about your users.

   ii. Custom user properties: Custom data that you can capture about your users and send to the platform.

   note

   You can have up to 120 user properties in User 360.

2. User Events: Track specific actions or activities performed by users within a system, application, or platform. For more details, see User 360 events and Custom events

---

System user properties

System properties are the default user properties that contain the essential data organizations need to capture from their users. If you need to capture additional information, you can create custom user properties.

The following are the available system user properties, you can see these in User 360.

Property Name	Data Type	Description
userId	string	Unique identifier for a user. As per your setting, this could be a mobile number, email address, or any unique identifier. For more details, see here.
firstName	string	The first name of the user
lastName	string	Last name of the user
gender	string	Gender of the user
country	string	Country of the user. In bot conversation, it identifies this property based on the location of the user’s IP address
city	string	City of the user. In bot conversation, it identifies this property based on the location of the user’s IP address
language	string	Preferred language of the user
timezone	string	Identifies based on the location of user's IP address
email	email	Email address of the user
phone	phone	Phone number of the user with country code
lastChannel	string	Recent channel (set up on yellow.ai) where the user had an active session You can update this property to cover touch-points/channels outside yellow.ai.
dob	date	Date of birth of the user.
emailOptin	boolean	Subscription status of the user to emails. The value is true if a user has subscribed to your emails, else it is false
smsOptin	boolean	Subscription status of the user to SMS. The value is true if a user has subscribed to your SMS, else it is false
whatsAppOptin	boolean	WhatsApp subscription status of the user. This is true if a user has subscribed to your WhatsApp messages, else it is false.
tags	list	List of groups associated to the user. You can add tags to users manually.

UserId as a property

The userId is a unique property in the users schema and serves as an identifier for each user. It helps in recognizing users across multiple touch-points, capture and update user data. A userId can be any unique identifier such as phone number, email address, or any other external unique identifier such as driving licence number.

For more details, see:

• Capture userId through bot conversation using the User identification flow.
• What happens when a userId is captured for the first time during bot conversation.
• What happens when a userId is recaptured during bot conversation.
• How to enrich user profiles with the data collected from multiple touch-points/channels
• How to offer personalised engegement across multiple touch-points/channels

info

Two records cannot have the same userId.

Tag as user property

A tag is a label used to categorise users based on certain characteristics or attributes. These labels can be used to segment customers into different groups for targeted marketing, sales, or customer service efforts. Some examples of customer labels include High-value, New customer, Inactive, or campaign responders.

A user can have more than one tag.

Custom user properties

Custom user properties refer to additional fields that you can create to capture information that is not covered by the default system properties. You can define these custom properties according to your business specific needs and requirements.

For instance, you might want to store details such as the number of times they have visited your pricing page, their department, and their preferred product.

note

Once a property is created, you cannot change its data type or delete it.

To create a new user property with your preferred label name and datatype, follow these steps:

1. On the User 360 page, click User properties.

   

2. Click on +Custom property

3. In Property name, enter a name for the property.

   

4. In Property type, choose the data type of the property.

The table lists the different datatypes supported for user properties.

Data Type	Description
string	Stores String data
number	Stores positive or negative integer, or a decimal number
time	Stores time in hh:mm:ss format
date	Stores date in YYYY-MM-DD format
datetime	Stores date and time in YYYY-MM-DD hh:mm:ss format
list	Stores an array of String values
boolean	Stores true or false
phone	Stores phone numbers with country code and validates the format by checking country code and number of digits
url	Stores URL and validates the format for the same
email	Stores email and validates the format for the same

4. To add more properties, click New property.

   

5. Click Save.

info

Currently, you cannot modify or delete a custom property once created.