Identify contacts

​

Identify a known contact

import { BrowserClient } from '@spotzee/js-sdk'

const spotzee = new BrowserClient({ apiKey: 'pk_…' })

await spotzee.identify({
  externalId: 'u_42',
  email: 'sam@example.com',
  phone: '+61491570006',
  timezone: 'Australia/Sydney',
  locale: 'en-AU',
  traits: {
    firstName: 'Sam',
    lastName: 'Patel',
    plan: 'starter',
    lifetimeValue: 199.50,
  },
})

import { Client } from '@spotzee/js-sdk'

const spotzee = new Client({ apiKey: process.env.SPOTZEE_API_KEY })

await spotzee.identify({
  anonymousId: 'anon_xyz',  // Optional. Pass a previously tracked ID to join its activity.
  externalId: 'u_42',
  email: 'sam@example.com',
  traits: {
    firstName: 'Sam',
    plan: 'starter',
  },
})

​

How traits flow

• email and phone: top-level fields the email and SMS channels read from. Pass them through identify arguments rather than nesting them in traits so the SDK puts them in the right place.
• timezone and locale: drive personalisation and send-time logic. Pass them through identify arguments. The browser SDK does not infer them; if you want browser locale, read navigator.language and pass it in.

​

Anonymous to known: automatic alias

await spotzee.alias({
  anonymousId: 'anon_xyz',
  externalId: 'u_42',
})

​

When to call identify

• On sign-up. First call after the user creates an account.
• On sign-in. So a user switching devices or browsers gets joined back to their record.
• When traits change. Updating profile data, plan, lifetime value, billing state. Identify is upsert: pass only the traits that changed.

​

Worked example: link anonymous browse to checkout

const spotzee = new BrowserClient({ apiKey: 'pk_…' })

// User browses anonymously. Track fires against the auto-minted anonymous ID.
await spotzee.track({
  event: 'Product viewed',
  properties: { sku: 'SHIRT-AU-12' },
})

// User signs in. Identify joins the anonymous session to the known account.
await spotzee.identify({
  externalId: 'u_42',
  email: 'sam@example.com',
  traits: { plan: 'starter' },
})

// Subsequent track calls automatically include both IDs. The "Product viewed"
// event from above is now part of u_42's history.
await spotzee.track({
  event: 'Checkout started',
  properties: { cartTotal: 89.95 },
})

​

Reset on sign-out

let spotzee = new BrowserClient({ apiKey: 'pk_…' })

function signOut() {
  spotzee = new BrowserClient({ apiKey: 'pk_…' })
}

​

Next steps