Identify a user
To fully harness the potential of In-App Messaging, you must segment and target your In-App Messaging campaigns to specific user subsets. By identifying users with additional information, including their device demographics, location and any attributes of your choosing, you will be able to display intelligent, targeted in-app messages to the right users.
1import { identifyUser } from 'aws-amplify/in-app-messaging';2
3const identifyUserInput = {4 userId: '', // E.g. user-id5 userProfile: {6 email: '', // E.g. example@service.com7 name: '', // E.g. name-of-the-user8 plan: '' // E.g. plan-they-subscribe-to9 customProperties: {10 // E.g. hobbies: ['cooking', 'knitting'],11 },12 demographic: {13 appVersion: '',14 locale: '', // E.g. en_US15 make: '', // E.g. Apple16 model: '', // E.g. iPhone17 modelVersion: '', // E.g. 1318 platform: '', // E.g. iOS19 platformVersion: '', // E.g. 1520 timezone: '' // E.g. Americas/Los_Angeles21 },22 location: {23 city: '', // E.g. Seattle24 country: '', // E.g. US,25 postalCode: '', // E.g. 9812126 region: '', // E.g. WA27 latitude: 0.0,28 longitude: 0.029 },30 metrics: {31 // E.g. logins: 15732 },33 },34};35
36await identifyUser(identifyUserInput);
Identify a user with Amazon Pinpoint
When using identifyUser
with Amazon Pinpoint, in addition to the other user info properties you can configure the address
, optOut
and userAttributes
properties under options
.
1import { identifyUser } from 'aws-amplify/in-app-messaging';2
3const identifyUserInput = {4 userId: '', // E.g. user-id5 options: {6 address: '' // E.g. A device token or email address7 optOut: '' // Either ALL or NONE8 userAttributes: {9 // E.g. interests: ['soccer', 'shoes'],10 }11 },12
13};14
15await identifyUser(identifyUserInput);