Skip to main content

User properties

1. 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

We store three types of data about your users:

  1. System user properties (a default set of data that we capture about your users).
  2. Custom user properties (data you send us about your users).
  3. Events (data that records specific activities of users).

1.1 System user properties

The following properties are enabled by default. You can see these in User 360.

Property NameData TypeDescription
userIdstringUnique identifier for a user NOTE: This can be passed
firstNamestringThe first name of the user
lastNamestringLast name of the user
genderstringGender of the user
countrystringIdentifies based on the location of the user’s IP address
citystringIdentifies based on the location of the user’s IP address
ipstringFetches from the user’s browser
latitudenumberIdentifies from the location of the user’s IP address
longitudenumberIdentifies from the location of the user’s IP address
languagestringPreferred language of the user
timezonestringIdentifies based on the location of user's IP address
emailemailEmail address of the user
phonephonePhone number of the user with country code
lastChannelstringRecent 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.
dobdateDate of birth of the user.
lastSessiondateTimetimestamp of the last time the user had an active session on one of the channels set up on yellow.ai NOTE: You can update this property to cover touch-points/channels outside yellow.ai
emailOptinbooleanSubscription status of the user to emails. The value is true if a user has subscribed to your emails, else it is false
smsOptinbooleanSubscription status of the user to SMS. The value is true if a user has subscribed to your SMS, else it is false
whatsAppOptinbooleanWhatsApp subscription status of the user. This is true if a user has subscribed to your WhatsApp messages, else it is false.
createdAtdateTimeTimestamp of when the user record was created
updatedAtdateTimeTimestamp of when the user record was recently updated
tagslistList of groups associated to the user. You can add tags to users manually.

1.3 User ID (userId) as a property

userId is a unique property in the users schema and is used to identify a user.

You need to set a userId (a unique user identifier) for every user that you create, to be able to recognise them as the same user on multiple touch-points. If userId is the same as email, you might want to pass it both as userId and email address.

Passing the userId for your users will allow you to identify them on multiple touch-points, which will further allow you to:

  • Offer personalised engagement across multiple touch-points/channels
  • Enrich the profile of that user with the data collected from multiple touch-points/channels

You can use userId to identify a user and use it to capture add/update user data, capture data through bot conversation.

danger

No two users can have the same userId

You can customise the fields or information that you want to capture for your users and set the order in which you want the fields to appear on the UI.

1.5 Tag as a 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.


2. Manage user properties

You can add the System properties that you want to capture for your users. If required, you can also create your own property (custom property) that you want to capture.

2.1 Add user property

To section explains how you can add a system property To add an existing user property to your User 360 module, follow these steps:

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

In the left panel, you can see the user schema, which includes all the system and custom properties along with their data types.

  1. Select the property that you want to include. You can see all the selected properties on the right.

2.2 Create custom user property

Custom properties store additional information specific to your users. For example, you might want to store details such as the number of times they have visited your pricing page, what their department is, and their preferred product.

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

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

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

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

The table lists the different datatypes supported for user properties.

Data TypeDescription
stringStores String data
numberStores positive or negative integer, or a decimal number
timeStores time in hh:mm:ss format
dateStores date in YYYY-MM-DD format
datetimeStores date and time in YYYY-MM-DD hh:mm:ss format
listStores an array of String values
booleanStores true or false
phoneStores phone numbers with country code and validates the format by checking country code and number of digits
urlStores URL and validates the format for the same
emailStores email and validates the format for the same
  1. To add more properties, click New property.

  2. Click Save.

info

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

2.3 Order user properties

You can set the order in which user properties has to appear on the interface.

To set the order:

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

  2. On the right pane, drag a property to the required position.

3. Create prsonalised conversations with user properties

If you’ve built a bot on yellow.ai, you can use the Conversational Studio to create hyper-personalised conversations based on user properties.

While these user properties are accessible in all the nodes of Studio, we’ll cover some of them with-in this document, to show you how you can create the right conversion for the right set of users.

For more details, see Using Builder to capture user data through conversations.

info

All user properties are accessible in nodes under “User properties”.

You can improve the engagement rates by creating personalised content. To do this, in your Message Nodes, you can can access user properties by clicking on the variable dropdown and selecting any User Property, or my simply accessing it using {{user.propertyName}}.

drawing