Create User Profile

This document will cover the methods to create a user and set communication channel preferences along with push notification token


Integrate Android SDK

How Suprsend identifies a user

Suprsend identifies Users by unique identifier distinct_id. The identifier for a user is important as we use this key to create user profile and all the information related to a user, like channel preferences, is attached to that profile. It's best to send the user's distinct_id from your DB to map it across different devices and platforms. You can view user profile by searching distinct_id on Subscribers page

Please note: you cannot change a user's id once it has been set, so we recommend you use a non-transient id like a primary key rather than a phone number or email address.

Step 1 : Create/Identify a new user

You can identify a user using ssApi.identify() method.

Call this method as soon as you know the identity of user, that is after login authentication. If you don't call this method, user will be identified using distinct_id (uuid) that sdk generates internally.

When you call this method, we internally create an event called $user_login. You can see this event on SuprSend workflows event list and you can configure a workflow on it.

//Sample Values
ssApi.identify("[email protected]");
distinct_idint, bigint, string, UUIDmandatory
Unique identifier for a user across devices or between multiple logins.

Step 2 : Call reset to clear user data on log out

As soon as the user logs out, call ssApi.reset() method to clear data attributed to a user. This will generate a new random distinct_id and clear all super properties. This allows you to handle multiple users on a single device.

When you call this method, we internally create an event called $user_logout. You can see this event on SuprSend workflows event list and you can configure a workflow on it.



Mandatory to call reset on logout

Don't forget to call reset on user logout. If not called, user id will not reset and multiple tokens and channels will get added to the user_id who logged in first on the device.

Step 3: Set Communication Channel preferences

You can send communication channel details of a user to the SuprSend SDK. We will store the channel details in the user profile. This will allow us to send communications to a user on the channels available for that user whenever there is any communication trigger.

1. Add User Channels

You can add SMS, Email and Whatsapp channel information by using below methods. You can call this on signup, or whenever a user provides the above channel information.

ssApi.getUser().setEmail("[email protected]")  // To add Email

ssApi.getUser().setSms("91XXXXXXXXXX")  // To add SMS

suprsend.user.setWhatsApp("+91XXXXXXXXXX"); // To add Whatsapp

Android Push will automatically be set at the time of user login. All you have to do is to integrate the push notification service in your application

Android Push Integration guide


Country Code Mandatory

Make sure you are sending the country code when you are calling communication methods for SMS and Whatsapp.

2. Remove User Channels

You can remove SMS, Email and Whatsapp channel information by using below methods. You can call this when a user updates his channel information. You need not call this when a user unsubscribes from a particular channel notification, as that will be handled in user preferences.

ssApi.getUser().unSetEmail("[email protected]");  // To remove Email

ssApi.getUser().unSetSms("91XXXXXXXXXX") // To remove SMS

ssApi.getUser().unSetWhatsApp("91XXXXXXXXXX") // To remove Whatsapp

Advanced Configuration - Set User Properties

You can use SuprSend SDK to set advanced user properties, which will help in creating a user profile. You can use these properties to create user cohorts on SuprSend's platform with future releases.

1. Set

Set is used to set the custom user property or properties. The given name and value will be assigned to the user, overwriting an existing property with the same name if present. It can take key as first param, value as second param for setting single user property or object for setting multiple user properties.

ssApi.getUser().set(key: String, value: Any) // for single property
ssApi.getUser().set(properties: JSONObject) // for multiple properties
//Example for setting single property
ssApi.getUser().set("purchased_value", 2599.50)
//Example for setting multiple properties
ssApi.getUser().set(JSONObject().apply {
    put("prime_member_group", "super")
    put("purchased_product", true")
    put("purchased_value", 2599.50")

This is property key that will be attached to user.

Should not start with $ or ss_
This will be value that will be attached to key property.
This is used in case of setting multiple user properties.


Naming Guidelines

When you create a key, please ensure that the Key Name does not start with $ or ss_, as we have reserved these symbols for our internal events and property names.

2. Set Once

Works just like ssApi.getUser().set, except it will not overwrite existing property values. This is useful for properties like First login date

ssApi.getUser().setOnce(key: String, value: Any) // for single property
ssApi.getUser().setOnce(properties: JSONObject)  // for multiple properties

//Sample for single property
ssApi.getUser().setOnce("first_login_at", "01-12-2021")

//Sample for multiple properties
ssApi.getUser().setOnce(JSONObject().apply {
    put("first_login_at", "01-12-2021")
    put("first_ordered_amount", "10000")
    put("first_ordered_product_name", "Car")

3. Increment

Add the given amount to an existing property on the user. If the user does not already have the associated property, the amount will be added to zero. To reduce a property, provide a negative number for the value.

ssApi.getUser().increment(key: String, value: Number) // for single property
ssApi.getUser().increment(properties: JSONObject) // for multiple properties
//Sample for single property  
ssApi.getUser().increment("login_count", 1)
ssApi.getUser().increment("amount", 45)
ssApi.getUser().increment("total", 1.5)
//Sample for multiple properties
        "login_count" to 1,
        "amount" to 45,
        "total" to 1.5

4. Append

This method will append a value to the list for a given property.

ssApi.getUser().append(key: String, value: Any) // for single property
ssApi.getUser().append(properties: JSONObject) // for multiple properties
//Sample for single property 
ssApi.getUser().append("choices", "ABC")

//Sample for multiple properties
ssApi.getUser().append(JSONObject().apply {
    put("choices", "ABC")
    put("first_ordered_amount", 4500.00)

5. Remove

This method will remove a value from the list for a given property.

ssApi.getUser().remove(key: String, value: Any)
ssApi.getUser().remove("choices", "ABC")

6. Unset

This will remove a property permanently from user properties.

ssApi.getUser().unSet(key: String) // for single property
ssApi.getUser().unSet(keys: List<String>) // for multiple properties

//Sample for single property

//Sample for multiple properties