Attributes

Custom attributes let you store any data about your contacts beyond the standard properties. Use them for targeting, segmentation, and personalization.

Not sure whether to use attributes or events? See Attributes vs. Events.

What are Custom Attributes?

Custom attributes are properties you define for your workspace. Examples:

• company - Company name

• teamSize - Number of team members

• industry - Business sector

• isTrialing - Whether on a trial

• referralSource - How they found you

Creating Custom Attributes

Method 1: Automatic Creation

When you send a new property via the embed script, Cueflow automatically creates the attribute:

Cueflow.init({
  id: 'user-123',
  email: '[email protected]',
  // Custom attributes - auto-created if they don't exist
  company: 'Acme Inc',
  teamSize: 50,
  isEnterprise: true
});

Method 2: Manual Creation

Create attributes in the dashboard for better control:

1. Go to Settings > Attributes

2. Click New Attribute

3. Configure:

   • Name - Display name (e.g., "Team Size")

   • Key - API key (e.g., "team_size")

   • Type - Text, Number, or Boolean

4. Click Create

Attribute Types

Text

For string values:

• Company names

• Industries

• Custom categories

• Free-form text

Cueflow.init({
  id: 'user-123',
  company: 'Acme Inc',
  industry: 'technology',
  referralSource: 'google'
});

Targeting operators:

• Equals / Not Equals

• Contains / Not Contains

• Starts With / Ends With

• Is Set / Is Not Set

Number

For numeric values:

• Team size

• Usage counts

• Revenue

• Scores

Cueflow.init({
  id: 'user-123',
  teamSize: 50,
  monthlyRevenue: 10000,
  npsScore: 8
});

Targeting operators:

• Equals / Not Equals

• Greater Than / Less Than

• Between

• Is Set / Is Not Set

Boolean

For true/false values:

• Feature flags

• Trial status

• Verification status

• Preferences

Cueflow.init({
  id: 'user-123',
  isTrialing: true,
  emailVerified: true,
  hasCompletedOnboarding: false
});

Targeting operators:

• Equals (true/false)

• Is Set / Is Not Set

Managing Attributes

View Attributes

Go to Settings > Attributes to see all custom attributes:

• Name and key

• Type

• Usage count

• Creation date

Edit Attributes

Click an attribute to edit:

• Change the display name

• View usage statistics

You cannot change the key or type after creation. Create a new attribute if needed.

Delete Attributes

1. Click the attribute

2. Click Delete

3. Confirm deletion

Deleting an attribute removes all stored values for all contacts. This cannot be undone.

Using Custom Attributes

In Targeting Rules

Target users by custom attributes:

Enterprise companies:

Custom Attribute → teamSize → Greater Than → 100

Trial users:

Custom Attribute → isTrialing → Equals → true

Specific industry:

Custom Attribute → industry → Equals → "healthcare"

Combining with Standard Properties

Mix custom attributes with standard properties:

Contact Property → Plan → Equals → "pro"
AND
Custom Attribute → teamSize → Greater Than → 10
AND
Custom Attribute → hasCompletedOnboarding → Equals → false

Best Practices

Naming Conventions

• Use snake_case for keys: team_size, is_trialing

• Use clear display names: "Team Size", "Is Trialing"

• Be consistent across your codebase

Data Types

• Choose the right type from the start

• Use Number for quantities (enables comparison operators)

• Use Boolean for yes/no values

• Use Text for categories and free-form

Planning

• Define attributes before implementation

• Document what each attribute means

• Avoid creating duplicate attributes

Performance

• Only create attributes you'll use

• Keep attribute count reasonable

• Remove unused attributes

Examples

SaaS Product

Cueflow.init({
  id: 'user-123',
  // Standard properties
  email: '[email protected]',
  plan: 'pro',

  // Custom attributes
  company: 'Acme Inc',
  teamSize: 25,
  industry: 'technology',
  isTrialing: false,
  monthlyActiveUsers: 1500,
  integrationsConnected: 3,
  hasApiAccess: true
});

E-commerce

Cueflow.init({
  id: 'customer-456',
  email: '[email protected]',

  // Custom attributes
  totalOrders: 12,
  lifetimeValue: 2500,
  preferredCategory: 'electronics',
  isVip: true,
  lastOrderDate: '2024-12-01'
});

Educational Platform

Cueflow.init({
  id: 'student-789',
  email: '[email protected]',

  // Custom attributes
  coursesEnrolled: 3,
  coursesCompleted: 1,
  currentLevel: 'intermediate',
  institution: 'State University',
  isInstructor: false
});

API Reference

Sending Attributes

Include in Cueflow.init() or Cueflow.update():

// Initial setup
Cueflow.init({
  id: 'user-123',
  customAttribute: 'value'
});

// Update later
Cueflow.update({
  customAttribute: 'new value'
});

Server-Side API

curl -X POST https://app.cueflow.so/api/v1/contacts \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]",
    "customAttributes": {
      "company": "Acme Inc",
      "teamSize": 50
    }
  }'