Set User Properties

Set user properties

Capture custom user data with the FS.setUserVars function, which takes a single argument: a Map containing key/value pairs you'd like to capture.

Parameters

userVars Map required

A Map with key/value pairs that provides additional information about your user.

Special Fields

These are reserved field names that can be included in userVars that have special meaning and usage.

displayName String optional

The value of displayName is displayed in the session list and on the user card in the app.

email String optional

The value of email is used to let you email the user directly from the app. The email value can also be used to retrieve users and sessions via the Get User and List Sessions HTTP APIs.

Limits

• Sustained calls are limited to 12 calls per minute, with a burst limit of 5 calls per second.

Additional Information

• Capturing custom user properties
• userVars name requirements
• userVars value requirements

FS.setUserVars(Map<String, Object?> userVars)

Example Invocation

FS.setUserVars({
  'displayName': 'Daniel Falko',
  'email': 'daniel.falko@example.com',
  'membershipLevel': 'platinum',
});