Cueflow.update()

Update user attributes after initialization. Use this when user data changes during a session.

Syntax

Cueflow.update(data)

Parameters

data (required)

An object containing properties to update. Only include properties you want to change.

Property	Type	Description
email	string	User's email address
name	string	Display name
phone	string	Phone number
avatarUrl	string	URL to profile image
role	string	User's role
plan	string	Subscription plan
signedUpAt	string	ISO 8601 signup date
[custom]	any	Any custom attributes

You cannot change the user's id with update(). To switch users, call Cueflow.shutdown() first, then Cueflow.init() with the new user.

Basic Example

// Update a single property
Cueflow.update({
  plan: 'enterprise'
});

Common Use Cases

Plan Upgrade

When a user upgrades their subscription:

async function handleUpgrade(newPlan) {
  await api.upgradePlan(newPlan);

  // Update Cueflow to reflect new plan
  Cueflow.update({
    plan: newPlan
  });
}

This immediately re-evaluates targeting rules, so messages targeted at free users will hide, and pro-only messages will show.

Profile Update

When user updates their profile:

function handleProfileSave(formData) {
  // Save to your backend
  api.updateProfile(formData);

  // Update Cueflow
  Cueflow.update({
    name: formData.name,
    email: formData.email,
    avatarUrl: formData.avatar
  });
}

Onboarding Completion

Track when user completes onboarding:

function completeOnboarding() {
  Cueflow.update({
    onboardingComplete: true,
    onboardingCompletedAt: new Date().toISOString()
  });
}

Feature Activation

When user enables a feature:

function enableFeature(featureName) {
  Cueflow.update({
    [`feature_${featureName}`]: true
  });
}

// Usage
enableFeature('dark_mode');
// Adds: { feature_dark_mode: true }

How It Works

When you call update():

1. Merges data - New properties are merged with existing user data

2. Syncs to server - Updated data is sent to Cueflow

3. Re-evaluates messages - Targeting rules are checked against new data

4. Updates display - Messages are shown/hidden based on new targeting

// Initial state
Cueflow.init({
  id: 'user-123',
  plan: 'free',
  teamSize: 5
});

// After update
Cueflow.update({
  plan: 'pro',
  teamSize: 10
});

// Resulting user data:
// {
//   id: 'user-123',
//   plan: 'pro',      // updated
//   teamSize: 10      // updated
// }

Multiple Updates

You can call update() multiple times:

// These are all valid
Cueflow.update({ plan: 'pro' });
Cueflow.update({ role: 'admin' });
Cueflow.update({
  company: 'Acme',
  teamSize: 50
});

Updating Custom Attributes

Custom attributes work the same way:

Cueflow.update({
  // Update existing custom attributes
  company: 'New Company Name',
  teamSize: 100,

  // Add new custom attributes
  industry: 'technology',
  hasApiAccess: true
});

Requirements

• Must call Cueflow.init() first

• Calling before init shows a warning: "Cueflow: Not initialized"

// Wrong - init not called yet
Cueflow.update({ plan: 'pro' });
// Warning: "Cueflow: Not initialized"

// Correct
Cueflow.init({ id: 'user-123', plan: 'free' });
Cueflow.update({ plan: 'pro' });

Next Steps

• Cueflow.track() - Track user events

• Custom Attributes - Learn about custom attributes