Skip to Content

The Prefs type of the TypeScript SDK, which identities.getPreferences and identities.setPreferences take or answer.

type Prefs = {
  prefs: Record<string, unknown>
  version: number
}

Fields

FieldTypeDescription
prefsRecord<string, unknown>User client preferences JSON key-value map. Opaque to the server with one exception: notifyNewClient: false turns off the mail the platform sends when a client reaches the identity from a new location (the identity.client.new event to the tenant's hooks is unaffected)
versionnumberMonotonic version counter for optimistic concurrency control (CAS)

Used by

MethodWhat it does
identities.getPreferencesGet identity preferences
identities.setPreferencesSave identity preferences

On this page