Set User Properties

Set properties on a user.

Capture custom user data with the FS('setProperties') function, which takes a single argument: an object or dictionary containing simple key/value pairs you'd like to capture.

Type annotations are no longer required. See Custom Properties.

Parameters

type string required

To set properties on your user you must set the type parameter to "user".

properties object required

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

schema object optional

A JSON object with key/value pairs that provide explicit type inference for your properties. See Custom Properties.

Special Fields

These are reserved field names that can be included in properties 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 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 30 calls per page per minute with a burst limit of 10 calls per second.

Additional Information

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

FS('setProperties', { type: 'user', properties });

Example Invocation

FS('setProperties', {
  type: 'user',
  properties: {
    displayName: 'Daniel Falko',
    email: 'daniel.falko@example.com',
    pricing_plan: 'free',
    popup_help: true,
    total_spent: 14.50
  }
});