Custom metadata

Set (replace): Replaces the entire custom_metadata object with the provided value. Any existing keys not included in the request are removed.
Update (partial): Performs a shallow merge of the provided keys into the existing custom_metadata object. Only the top-level keys you specify are updated; all unspecified keys are preserved.

Use the PrivyClient’s setCustomMetadata method from the users() interface to set the custom metadata field for a user by their ID. As parameters, pass the user’s ID as a string and the JSON object that you wish to set as custom metadata:

import {PrivyClient} from '@privy-io/node';

const privy = new PrivyClient({
  appId: process.env.PRIVY_APP_ID!,
  appSecret: process.env.PRIVY_APP_SECRET!
});

try {
  const user = await privy.users().setCustomMetadata('insert-user-id', {
    custom_metadata: {
      username: 'name'
    }
  });
} catch (error) {
  console.error(error);
}

If a matching user is found for the ID and the custom metadata object is valid, the method will return the corresponding User object with updated custom metadata. If no matching user is found, or the custom metadata input is malformed or too large (>1KB), the method will throw an error.

Users

User management

Managing users

Migrating users to Privy

Webhooks