Set user attributes in Capacitor SDK

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() method:

import { adapty } from '@adapty/capacitor';

const params = {
  email: '[email protected]',
  phoneNumber: '+18888888888',
  firstName: 'John',
  lastName: 'Appleseed',
  gender: 'other',
  birthday: new Date().toISOString(),
};

try {
  await adapty.updateProfile(params);
  console.log('Profile updated successfully');
} catch (error) {
  console.error('Failed to update profile:', error);
}

Please note that the attributes that you've previously set with the updateProfile method won't be reset.

tip

Want to see a real-world example of how Adapty SDK is integrated into a mobile app? Check out our sample apps, which demonstrate the full setup, including displaying paywalls, making purchases, and other basic functionality.

The allowed keys list

The allowed keys of AdaptyProfileParameters and their values are listed below:

Key	Value
email	String up to 30 characters
phoneNumber	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 string in ISO format

Custom 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 exercises 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.

import { adapty } from '@adapty/capacitor';

try {
  await adapty.updateProfile({
    codableCustomAttributes: {
      key_1: 'value_1',
      key_2: 2,
    },
  });
  console.log('Custom attributes updated successfully');
} catch (error) {
  console.error('Failed to update custom attributes:', error);
}

To remove existing keys, pass null as their values:

import { adapty } from '@adapty/capacitor';

try {
  // to remove keys, pass null as their values
  await adapty.updateProfile({
    codableCustomAttributes: {
      key_1: null,
      key_2: null,
    },
  });
  console.log('Custom attributes removed successfully');
} catch (error) {
  console.error('Failed to remove custom attributes:', error);
}

Sometimes you need to figure out what custom attributes have already been installed before. To do this, use the customAttributes field of the AdaptyProfile object.

warning

Keep in mind that the value of customAttributes may be out of date since the user attributes can be sent from different devices at any time so the attributes on the server might have been changed after the last sync.

Limits

• Up to 30 custom attributes per user
• Key names are up to 30 characters long. The key name can include alphanumeric characters and any of the following: _ - .
• Value can be a string or float with no more than 50 characters.