CRM

The CRM module manages customer records and audience subscriptions for your business. Customers are business-scoped — each business has its own customer list. A customer can be linked to orders, bookings, reactions, and audience subscriptions, and can authenticate via email magic codes.

Key Concepts

Customer vs Account

• Account — platform-level auth identity. One person, one Account across all businesses.
• Customer — business-level CRM record (emails, blocks, taxonomies, audience subscriptions). Each business has its own view of a customer.

Blocks and Taxonomies

Customer data (name, phone, addresses, notes, tags, etc.) is stored as blocks and taxonomies — the same content model used by the CMS. This lets a business define its own custom customer fields instead of being locked into a fixed schema.

Multiple Emails

Customers support multiple emails. The initialize flow creates an anonymous guest customer; emails are attached once the customer authenticates with requestCode / verify or is updated by an admin.

Customer Endpoints

Create Customer (Admin)

Creates a new customer. If a customer with the same email already exists, returns the existing one (idempotent).

Initialize Customer (Public)

Public endpoint for end users. Creates an anonymous guest customer and returns an auth token. No email required — use this to get a customer session before any identity is known. The returned token can later be upgraded by calling connect or requestCode + verify.

Connect Customer (Public)

Attaches an email to the current customer session (or returns/creates a customer matching the email). Returns a fresh auth token.

Request Auth Code (Public)

Sends a verification code to the given email address. Use this to start a customer login flow.

Verify Auth Code (Public)

Exchanges a verification code for an auth token, marking the customer as verified.

Refresh Token (Public)

Exchanges a refresh token for a new access token.

Get Current Customer

Returns the currently authenticated customer based on the bearer token.

Get Customer

Find Customers

Search and list customers.

Update Customer

Merge Customers

Merges a source customer into the target. Source emails, blocks, and subscriptions are appended to the target. The source is permanently deleted (GDPR-compliant). All orders, bookings, reactions, and audience subscriptions are re-pointed to the target customer.

Revoke Session Token

Revokes a single active session for a customer.

Revoke All Session Tokens

Revokes every active session for a customer (logout everywhere).

Customer Object

{
  "id": "uuid",
  "businessId": "uuid",
  "emails": ["john@example.com"],
  "status": "active",
  "blocks": [],
  "taxonomies": [],
  "promoUsage": [],
  "authTokens": [],
  "verificationCodes": [],
  "audienceSubscriptions": [],
  "reactions": [],
  "createdAt": 1234567890,
  "updatedAt": 1234567890
}

Audiences

Audiences are subscriber groups used for content gating, newsletters, and paid memberships. They live under the CRM module as sdk.crm.audiences.*.

Key Concepts

An audience is a subscriber group with two dimensions:

• Type: standard (free) or paid (Stripe checkout)
• Confirmation: Optional double opt-in via an email template (confirmTemplateId)

Use cases: newsletter subscriptions, premium memberships, course access, tiered content.

Create Audience

Get Audience

Look up an audience by ID or by key.

Find Audiences

Update Audience

The type cannot be changed after creation, but you can update the key, status, and confirmation template.

Subscribe to Audience

Subscribe a customer to an audience. Behavior depends on the audience configuration:

• Standard, no confirmation: Subscription is immediately active
• Standard, with confirmation: Subscription is pending until the user clicks the confirmation link
• Paid: Returns a Stripe checkout URL

Check Access

Check if the current customer has access to an audience.

Get Subscribers

List subscribers for an audience (admin only).

Add Subscriber

Add a subscriber by customer ID (admin only). Skips if already subscribed.

Remove Subscriber

Typical Flows

E-commerce Checkout

// 1. Initialize a guest customer session
const token = await sdk.crm.initialize();

// 2. Attach the shopper's email
await sdk.crm.connect({ email: shippingAddress.email });

// 3. Checkout — the authenticated customer is resolved from the token
const order = await sdk.eshop.checkout({
  items: [...],
  shippingAddress: {...}
});

Newsletter Subscribe with Double Opt-in

// 1. Initialize + connect to get a customer
await sdk.crm.initialize();
const { id: customerId } = await sdk.crm.connect({ email: "user@example.com" });

// 2. Subscribe to the audience (sends confirmation email)
await sdk.crm.audiences.subscribe({
  id: audienceId,
  customerId,
  confirmUrl: 'https://yoursite.com/confirm'
});

Customer Login (Magic Code)

// 1. Ask for a code
await sdk.crm.requestCode({ email: "user@example.com" });

// 2. User enters the code from their email
const token = await sdk.crm.verify({
  email: "user@example.com",
  code: "123456"
});

// 3. Persist token.refreshToken and use token.accessToken for subsequent calls