Manage Users - SuprSend, Notification infrastructure for Product teams

How Suprsend identifies a user

SuprSend identifies users with immutable distinct_id. It’s best to map the same identifier in your DB with distinct_id in SuprSend. Do not use identifiers that can be changed like email or phone number. You can view synced users by searching distinct_id on Users page.

Identify user and Set Push token

Create/Identify a new user

You can identify a user using thesuprsend.identify() method. iospsuh token is automatically set in user’s profile when this method is called. 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.

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.

suprsend.identify(distinct_id);

//Sample Values
suprsend.identify("291eaa13-62f5-4d52-b2dd");

Parameters	Type	Description
distinct_id	int, bigint, string, UUID	mandatory Unique identifier for a user across devices or between multiple logins.

Call reset to clear user data on log out

As soon as the user logs out, call suprsend.reset() method to clear data attributed to a user. This allows you to handle multiple user logins on a single device and keep their data isolated from each other.

suprsend.reset();

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

Set communication channels

Mobile Push tokens automatically gets updated in user profile on suprsend.identify() call. All you have to do is to integrate push notification service in your application to start sending mobile push notification. To set other communication channels, use below methods:

Add User Channels

Add user channels on signup, or whenever a user updates their communication channels in the application flow.

Javascript

suprsend.user.setEmail("user@example.com");  // To add Email

suprsend.user.setSms("+91XXXXXXXXXX");  // To add SMS, mandatory to pass country code

suprsend.user.setWhatsApp("+91XXXXXXXXXX"); // To add Whatsapp, mandatory to pass country code

Remove User Channels

suprsend.user.unSetEmail("user@example.com");  // To remove Email

suprsend.user.unSetSms("+91XXXXXXXXXX");  // To remove SMS

suprsend.user.unSetWhatsApp("+91XXXXXXXXXX"); // To remove Whatsapp

Set user properties

(currently not available in iOS SDK)

You can sync other user properties in SuprSend and use it to pass dynamic content in template or add in workflow conditions.

Set

Set is used to add property. Set is upsert function and will override existing values corresponding to a key.

// for single property
suprsend.user.set(key, value);
suprsend.user.set("name", "john doe");

// for multiple properties
suprsend.user.set(property_obj);
suprsend.user.set({"name" :  "john doe", "age" : "27"});

Key should not start with $ or ss_, as we have reserved these symbols for our internal events and property names.

Set Once

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

suprsend.user.setOnce(key, value);  // for single property
suprsend.user.setOnce(properties);  // for multiple properties

// Sample values for setting once a single property:
suprsend.user.setOnce("first_login", "2021-11-02");

// Sample values for setting once multiple properties:
suprsend.user.setOnce({"first_login" : "2021-11-02", "DOB" : "1991-10-02"});

Unset

This will remove a property key

suprsend.user.unSet(key);  // for single property
suprsend.user.unSet(property_list);  // for multiple properties

// Sample values for unsetting a single property:
suprsend.user.unSet("wishlist");

// Sample values for unsetting multiple properties:
suprsend.user.unSet(["wishlist", "cart"]);

Append

This method will append a value to an array

suprsend.user.append(key, value);
suprsend.user.append(property_obj);  // for multiple properties

// Sample values for appending a single property:
suprsend.user.append("wishlist", "iphone12");

// Sample values for appending multiple properties:
suprsend.user.append({"wishlist" : "iphone12", "wishlist" : "Apple airpods"});

Remove

This will remove value from an array but not remove property key

// for single property
suprsend.user.remove(key, value);
suprsend.user.remove("wishlist", "iphone12");

// for multiple properties
suprsend.user.remove(property_obj);
suprsend.user.remove({"wishlist" : "iphone12", "wishlist": "Apple airpods"});

Increment

Increase or decrease integer values on consecutive action, like login count. To reduce a property, provide a negative number for the value.

// for single property
suprsend.user.increment(key, value);
suprsend.user.increment("login_count", 1);

// for multiple properties
suprsend.user.increment(property_obj);
suprsend.user.increment({"login_count" : 1, "order_count" : 1});
// Sample values for incrementing a single property:


// Sample values for incrementing multiple properties:

Changelog

​How Suprsend identifies a user

​Identify user and Set Push token

​Set communication channels

​Set user properties

How Suprsend identifies a user

Identify user and Set Push token

Set communication channels

Set user properties