FeatureFlareUserPayload
User identity and attribute object passed into the React provider and hooks.
More on this: pair this page with FeatureFlareProvider to understand controlled and uncontrolled user ownership.
export type FeatureFlareUserPayload = {
id?: string;
key?: string;
email?: string;
name?: string;
country?: string;
meta?: Record<string, string | number | boolean | null>;
custom?: Record<string, string | number | boolean | null>;
session?: Record<string, string | number | boolean | null>;
metrics?: Record<string, string | number | boolean | null>;
};Identity Fields
id?: string
Preferred unique user identifier.
key?: string
Legacy alias for the user identifier.
email?: string
Optional email attribute used for targeting or analytics context.
name?: string
Optional display name for the current user.
country?: string
Optional country or region attribute for targeting rules.
Attribute Bags
meta?: Record<string, string | number | boolean | null>
Primary queryable attribute bag for targeting inputs.
custom?: Record<string, string | number | boolean | null>
Legacy alias for custom/meta attributes.
session?: Record<string, string | number | boolean | null>
Session-scoped data reserved for product and analytics features.
metrics?: Record<string, string | number | boolean | null>
Counters or metric values associated with the current evaluator.
Notes
- Evaluation flows expect at least one stable identifier in either id or key.
- meta is the preferred attribute bag; custom is retained for backwards compatibility.
Related docs
- FeatureFlareProvider for provider props that consume this payload.