Sync your users

Create or map Whop users with your own platform users.

Sync users before you mint account-scoped user tokens for embedded chat. The user you pass as user_id must exist on Whop, and you can provide an account-specific name and profile picture that appears for that user in chat.

This isn’t needed for OAuth. If you use OAuth, the user signs in to Whop and the OAuth token identifies their Whop account.

1. Enroll users as connected accounts

Create a connected account for each user on your platform. This is the same flow used by the payouts SDK — see the Enroll connected accounts guide for the full walkthrough.

import { WhopClient } from "@whop/sdk";

const client = new WhopClient({ token: process.env.WHOP_API_KEY });

const account = await client.companies.create({
  email: "[e-mail]",
  parent_company_id: "biz_XXXXXXXXXXXXX", // your platform's account ID
  title: "Jane Doe",
  metadata: {
    internal_user_id: "user_12345", // your platform's user ID
  },
});

Save the resulting user ID on your side — you’ll pass it when minting account-scoped chat tokens.

2. Set an account-specific name and profile picture

Call the Update user endpoint with your account ID to define overrides shown for that user in the context of your account. Without an account ID, the fields update the user’s global profile instead.

Upload avatars through the Create file endpoint, then pass the returned file ID as the profile picture.

Call this whenever a user’s profile changes on your platform so Whop stays in sync.

The Update user endpoint requires the user:profile:update permission on the API key making the request. Use an account API key with owner-level access, or a key that includes the user:profile:update scope.

Next steps

Authentication

Mint account-scoped user tokens for embedded chat.

OAuth

Use Whop sign-in instead of syncing users yourself.

Chat element

Render a live chat UI once your users are authenticated.

Enroll connected accounts

Learn the full connected-account enrollment flow.