Assign or move a user ID

Assigns or moves a user ID to a cluster.

The time it takes to move a user is proportional to the amount of data linked to the user ID.

Usage

Requires Admin API key
1
2
3
4
5
6
7
8
9
import { algoliasearch } from 'algoliasearch';

//
const client = algoliasearch('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY');

const response = await client.assignUserId({
  xAlgoliaUserID: 'userID',
  assignUserIdParams: { cluster: 'theCluster' },
});
Did you find this page helpful?
JavaScript API clients v5