Target onboardings to different user groups

You can display different onboarding flows based on user attributes: acquisition source, campaign, geography, device type, lifecycle state, or user intent. Matching onboarding content to specific user groups improves activation rates and early engagement. The setup involves both developer work and dashboard configuration.

Before you start

• SDK version: Your app must use Adapty SDK v3.8.0+ (iOS, Android, React Native, Flutter), v3.14.0+ (Unity), or v3.15.0+ (Kotlin Multiplatform, Capacitor). See Onboardings for details.
• Onboardings: Create at least two onboardings in Adapty before starting — one default and one per segment. See Create onboarding.
• Attribution tools: If your app uses AppsFlyer, Adjust, Branch, or another attribution integration, campaign and source data may already be available as user attributes in Adapty. You can use this data directly in segments — skip to Step 2.

Step 1. Assign custom attributes to users (Developer)

Call updateProfile early in the user’s session, before the onboarding is displayed. The attribute must be available when Adapty evaluates which onboarding to show.

do {
    var builder = AdaptyProfileParameters.Builder()
    builder = try builder.with(customAttribute: "yoga", forKey: "campaign")
    try await Adapty.updateProfile(params: builder.build())
} catch {
    // handle the error
}

val builder = AdaptyProfileParameters.Builder()
builder.withCustomAttribute("campaign", "yoga")

Adapty.updateProfile(builder.build()) { error ->
    if (error != null) {
        // handle the error
    }
}

try {
  await adapty.updateProfile({
    codableCustomAttributes: {
      campaign: 'yoga',
    },
  });
} catch (error) {
  // handle `AdaptyError`
}

try {
  final builder = AdaptyProfileParametersBuilder()
    ..setCustomStringAttribute('yoga', 'campaign');
  await Adapty().updateProfile(builder.build());
} on AdaptyError catch (adaptyError) {
  // handle the error
} catch (e) {
  // handle the error
}

try {
    var builder = new Adapty.ProfileParameters.Builder()
        .SetCustomStringAttribute("campaign", "yoga");

    Adapty.UpdateProfile(builder.Build(), (error) => {
        if (error != null) {
            // handle the error
        }
    });
} catch (Exception e) {
    // handle the exception
}

import com.adapty.kmp.models.AdaptyProfileParameters

val builder = AdaptyProfileParameters.Builder()
builder.withCustomAttribute("campaign", "yoga")

Adapty.updateProfile(builder.build())
    .onSuccess {
        // profile updated successfully
    }
    .onError { error ->
        // handle the error
    }

try {
  await adapty.updateProfile({
    codableCustomAttributes: {
      campaign: 'yoga',
    },
  });
} catch (error) {
  // handle the error
}

For available attribute types and key/value limits, see the set user attributes guide for your platform: iOS | Android | React Native | Flutter | Unity | Kotlin Multiplatform | Capacitor

Step 2. Add users to segments (Dashboard)

Group users by the assigned attributes into segments:

1. In the dashboard, go to Profiles & Segments and switch to the Segments tab. There, click Create segment.
2. Fill in the segment name and description.
3. Click Add users attributes and select an attribute from the list.

4. Create one segment for each attribute you plan to use.

Step 3. Set up placement (Dashboard)

For Adapty to decide which onboarding to display, create a placement and add all the segments as audiences to it:

1. In the dashboard, go to Placements, and switch to the Onboardings tab. There, click Create placement.
2. Fill in the placement name and ID.
3. Click Run onboarding. In the dialog, select the onboarding to show by default to users not included in any segment. Click Submit.

4. At the top right, click Add audience. Select a segment and the onboarding to display to users in that segment. Click Submit.
5. Add audiences for all the segments and onboardings you need.

6. Click Save & Publish to make this placement available to the Adapty SDK.

Step 4. Display onboardings (Developer)

Use the placement ID to retrieve and display onboardings in your app. Follow the platform-specific guide: iOS | Android | React Native | Flutter | Unity | Kotlin Multiplatform | Capacitor