Setting User Attributes

You can set optional attributes such as email, phone number, etc, to the user of your app. You can then use attributes to create user segments or just view them in CRM.

Setting user attributes

To set user attributes, call .updateProfile() (profile.update() for React Native) method:

let params = ProfileParameterBuilder()
    .withEmail("[email protected]")
    .withPhoneNumber("+1-###-###-####")
    ...with<Key>(<Value>)
    
Adapty.updateProfile(params: params) { (error) in
    if error == nil {
        // successful update                              
    }
}

val params = ProfileParameterBuilder()
    .withEmail("[email protected]")
    .withBirthday(Date(1970, 1, 3))
    .withCustomAttributes(mapOf("key1" to value1, "key2" to value2))
    ...with<Key>(<Value>)

Adapty.updateProfile(params) { error ->
    if error == null {
        // successful update                              
    }
}

final AdaptyProfileParameterBuilder profileBuilder = AdaptyProfileParameterBuilder();
profileBuilder.setEmail('[email protected]');
profileBuilder.setPhoneNumber('+1-###-###-####');
...
profileBuilder.set<Key>(<Value>);

try {
    await Adapty.updateProfile(profileBuilder);
} on AdaptyError catch (adaptyError) {}
catch (e) {}

try {
    await adapty.profile.update({
    email: '[email protected]',
    firstName: 'Name',
    gender: 'male',
  });
} catch (error: AdaptyError) {}

var profileBuilder = new Adapty.ProfileParameterBuilder();
profileBuilder.FirstName = "TestFirstName";
profileBuilder.LastName = "TestLastName";
profileBuilder.SetBirthday(1984, 11, 11);

AdaptySDKExampleWrapper.UpdateProfile(profileBuilder, (error) => { 
    if (error != null) {
        // handle error
        return;
    }

    // successful update
});

The allowed keys list

The allowed keys <Key> of ProfileParameterBuilder() and the values <Value> are listed below:


email	String up to 30 characters
phoneNumber	String up to 15 characters
facebookUserId	String up to 30 characters
facebookAnonymousId	String up to 30 characters
amplitudeUserId	String up to 30 characters
amplitudeDeviceId	String up to 30 characters
mixpanelUserId	String up to 30 characters
appmetricaProfileId	String up to 30 characters
appmetricaDeviceId	String up to 30 characters
firstName	String up to 30 characters
lastName	String up to 30 characters
gender	Enum, allowed values are: `female`, `male`, `other`
birthday	Date
appTrackingTransparencyStatus (iOS only)	`ATTrackingManager.AuthorizationStatus`, app tracking transparency status you can receive starting from iOS 14. To receive it just call `let status = ATTrackingManager.AuthorizationStatus`. You should send this specific property to Adapty as soon as it changes. `let params = ProfileParameterBuilder() .withAppTrackingTransparencyStatus(status)`
customAttributes	Dictionary

Customer user attributes

You can set your own custom attributes. These are usually related to your app usage. For example, for fitness applications, they might be the number of training per week, for language learning app user's knowledge level, and so on. You can use them in segments to create targeted paywalls and offers, and you can also use them in analytics to figure out which product metrics affect the revenue most.

You can set up to 10 custom attributes for the user, the attribute's key and value should be up to 30 characters. The keys can be only strings of letters, numbers, dashes, points, and underscores. The values can be both strings and numbers. Boolean values will be converted to integers.